From 41202f5a62f6af2d6ca11cc8ff6d86287c5384cb Mon Sep 17 00:00:00 2001 From: Dan Moore Date: Tue, 29 Aug 2023 14:04:12 -0600 Subject: [PATCH] Make it clearer which webhook types are for premium, enterprise and community plans (#2446) --- site/docs/v1/tech/apis/_event-types.adoc | 14 +++++++++++--- 1 file changed, 11 insertions(+), 3 deletions(-) diff --git a/site/docs/v1/tech/apis/_event-types.adoc b/site/docs/v1/tech/apis/_event-types.adoc index 8b9f510634..2d8bb78b2a 100644 --- a/site/docs/v1/tech/apis/_event-types.adoc +++ b/site/docs/v1/tech/apis/_event-types.adoc @@ -1,6 +1,3 @@ -:premium_feature: this event -:enterprise_feature: this event - * ``audit-log.create`` - When an audit log is created [since]#Available since 1.30.0# * ``event-log.create`` - When an event log is created [since]#Available since 1.30.0# * ``jwt.public-key.update`` - When a JWT RSA Public / Private keypair may have been changed @@ -20,40 +17,49 @@ * ``user.identity-provider.unlink`` - When an existing Identity Provider link is removed from a User [since]#Available since 1.36.0# * ``user.loginId.duplicate.create`` - When a request to create a user with a login Id (email or username) which is already in use has been received [since]#Available since 1.30.0# + +:enterprise_feature: pass:quotes[the ``user.loginId.duplicate.create`` event] include::../shared/_enterprise-edition-blurb-api.adoc[] * ``user.loginId.duplicate.update`` - When a request to update a user and change their login Id (email or username) to one that is already in use has been received [since]#Available since 1.30.0# + +:enterprise_feature: pass:quotes[the ``user.loginId.duplicate.update`` event] include::../shared/_enterprise-edition-blurb-api.adoc[] * ``user.login.failed`` - When a user fails a login request [since]#Available since 1.6.0# * ``user.login.new-device`` - When a user begins a login request with a new device [since]#Available since 1.30.0# + +:enterprise_feature: pass:quotes[the ``user.login.new-device`` event] include::../shared/_enterprise-edition-blurb-api.adoc[] * ``user.login.success`` - When a user completes a login request [since]#Available since 1.6.0# * ``user.login.suspicious`` - When a user logs in and is considered to be a potential threat (requires an activated Enterprise license) [since]#Available since 1.30.0# + +:enterprise_feature: pass:quotes[the ``user.login.suspicious`` event] include::../shared/_enterprise-edition-blurb-api.adoc[] * ``user.password.breach`` - When Reactor detects a user is using a potentially breached password (requires an activated license) [since]#Available since 1.15.0# + +:premium_feature: pass:quotes[the ``user.password.breach`` event] include::../shared/_premium-edition-blurb-api.adoc[] * ``user.password.reset.send`` - When a forgot password email has been sent to a user [since]#Available since 1.30.0# + +:enterprise_feature: pass:quotes[the ``user.password.reset.send`` event] include::../shared/_enterprise-edition-blurb-api.adoc[] * ``user.password.reset.start`` - When the process to reset a user password has started [since]#Available since 1.30.0# + +:enterprise_feature: pass:quotes[the ``user.password.reset.start`` event] include::../shared/_enterprise-edition-blurb-api.adoc[] * ``user.password.reset.success`` - When a user has successfully reset their password [since]#Available since 1.30.0# + +:enterprise_feature: pass:quotes[the ``user.password.reset.success`` event] include::../shared/_enterprise-edition-blurb-api.adoc[] * ``user.password.update`` - When a user has updated their password [since]#Available since 1.30.0# + +:enterprise_feature: pass:quotes[the ``user.password.update`` event] include::../shared/_enterprise-edition-blurb-api.adoc[] * ``user.reactivate`` - When a user is reactivated @@ -66,10 +72,12 @@ include::../shared/_enterprise-edition-blurb-api.adoc[] * ``user.registration.verified`` - When a user completes registration verification [since]#Available since 1.8.0# * ``user.two-factor.method.add`` - When a user has added a two-factor method [since]#Available since 1.30.0# + +:enterprise_feature: pass:quotes[the ``user.two-factor.method.add`` event] include::../shared/_enterprise-edition-blurb-api.adoc[] * ``user.two-factor.method.remove`` - When a user has removed a two-factor method [since]#Available since 1.30.0# + +:enterprise_feature: pass:quotes[the ``user.two-factor.method.remove`` event] include::../shared/_enterprise-edition-blurb-api.adoc[] * ``user.update`` - When a user is updated