Skip to content

Update webhooks application #246

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 4 commits into from
Oct 19, 2020
Merged

Update webhooks application #246

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
cc1d533
Adding in doc about application specific webhooks.
mooreds Oct 12, 2020
31654d4
wordsmithing.
mooreds Oct 12, 2020
1ba105c
Reworked based on Daniel's feedback.
mooreds Oct 13, 2020
7d02b2e
Wordsmithing.
mooreds Oct 13, 2020
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
25 changes: 25 additions & 0 deletions site/docs/v1/tech/events-webhooks/events.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,31 @@ These are the events that FusionAuth generates that can be optionally consumed b
* <<JWT Refresh>> - when an access token is refreshed using a refresh token
* <<JWT Refresh Token Revoke>> - when a refresh token (or multiple tokens) are revoked

=== Application Scoped Events

A few events can be generated for one or more specified applications, or for all applications within a tenant.

[WARNING]
====
The ability to limit the generation of an event for only certain applications is legacy functionality and may be modified in the future. You almost certainly want to use a tenant scoped event and optionally filter on the `applicationId` when consuming the event.
====

These events can be application scoped:

* `user.action`
* `jwt.refresh-token.revoke`
* `jwt.refresh`
* `jwt.public-key.update`

=== Tenant Scoped Events

Any events which are not application scoped events are tenant scoped.

Tenant scoped events can't be limited to fire only for a certain application. These events are either generated for all applications in a tenant or for none of them.

All user events are tenant scoped because a user is a tenant scoped entity. For example, the `user.delete`, `user.create`, `user.update`, and `user.deactivate` events are all tenant scoped.

A tenant scoped event can, however contain an `applicationId` which can be used to filter events when received. One example is `user.registration.create`.

== User Actions

Expand Down