Skip to content

docs(webhooks): add webhook documentation #13

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

Open
Crashdoom wants to merge 2 commits into
base: main
Choose a base branch
from
Open

docs(webhooks): add webhook documentation #13

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b11dc89
docs(webhooks): add webhook documentation
Crashdoom Aug 25, 2022
a5e4528
docs(webhooks): finish documentation
Crashdoom Aug 25, 2022
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
2 changes: 1 addition & 1 deletion docs/api/endpoints/v0/users.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ hide_table_of_contents: true
The email address of the user.
</attribute>
<attribute id="su-resp-preferredName" name="preferredName" type="string" response optional>
The preferred name of the user. If provided, this should be used instead of the first and ast name, except where legally required.
The preferred name of the user. If provided, this should be used instead of the first and last name, except where legally required.
</attribute>
<attribute id="su-resp-firstName" name="firstName" type="string" response>
The first name of the user.
Expand Down
4 changes: 4 additions & 0 deletions docs/api/webhooks/_category_.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"label": "Webhooks",
"position": 3
}
9 changes: 9 additions & 0 deletions docs/api/webhooks/about.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# About Webhooks

Webhooks allow you to set up external applications to receive notifications when certain events happen. When a webhook event is triggered, we'll send a HTTP POST payload to the provided URL for the application.

These webhook events can be used to trigger automated actions in third-party applications, such as updating access control, mailing lists, and more.

## Test event

When you setup a webhook, you can send a test event to verify that the webhook is working correctly by using the **Test** button in Housekeeping.
Loading