fix: webhooks missing triggers and events

Add missing email create webhook trigger and add events and trigger calls for username changes. Update readme with missing/new webhook events.
teamhanko · Jan 30, 2025 · 9836c48 · 9836c48
1 parent ce9626d
commit 9836c48
Show file tree

Hide file tree

Showing 8 changed files with 64 additions and 28 deletions.
diff --git a/backend/README.md b/backend/README.md
@@ -545,16 +545,20 @@ To decode the webhook you can use the JWKs created in [Configure JSON Web Key Se
 
 Hanko sends webhooks for the following event types:
 
-| Event                     | Triggers on                                                                                        |
-|---------------------------|----------------------------------------------------------------------------------------------------|
-| user                      | user creation, user deletion, user update, email creation, email deletion, change of primary email |
-| user.create               | user creation                                                                                      |
-| user.delete               | user deletion                                                                                      |
-| user.update               | user update, email creation, email deletion, change of primary email                               |
-| user.update.email         | email creation, email deletion, change of primary email                                            |
-| user.update.email.create  | email creation                                                                                     |
-| user.update.email.delete  | email deletion                                                                                     |
-| user.update.email.primary | change of primary email                                                                            |
+| Event                       | Triggers on                                                                                        |
+|-----------------------------|----------------------------------------------------------------------------------------------------|
+| user                        | user creation, user deletion, user update, email creation, email deletion, change of primary email |
+| user.create                 | user creation                                                                                      |
+| user.delete                 | user deletion                                                                                      |
+| user.update                 | user update, email creation, email deletion, change of primary email                               |
+| user.update.email           | email creation, email deletion, change of primary email                                            |
+| user.update.email.create    | email creation                                                                                     |
+| user.update.email.delete    | email deletion                                                                                     |
+| user.update.email.primary   | change of primary email                                                                            |
+| user.update.username.create | username creation                                                                                  |
+| user.update.username.delete | username deletion                                                                                  |
+| user.update.username.update | change of username                                                                                 |
+| email.send                  | an email was sent or should be sent                                                                |
 
 As you can see, events can have subevents. You are able to filter which events you want to receive by either selecting
 a parent event when you want to receive all subevents or selecting specific subevents.

diff --git a/backend/config/config_webhook.go b/backend/config/config_webhook.go
@@ -84,18 +84,26 @@ func (Webhook) JSONSchemaExtend(schema *jsonschema.Schema) {
 		"user.update.email.create",
 		"user.update.email.delete",
 		"user.update.email.primary",
+		"user.update.username",
+		"user.update.username.create",
+		"user.update.username.delete",
+		"user.update.username.update",
 		"email.send",
 	}
 	evts.Items.Extras = map[string]any{"meta:enum": map[string]string{
-		"user":                      "Triggers on: user creation, user deletion, user update, email creation, email deletion, change of primary email",
-		"user.create":               "Triggers on: user creation",
-		"user.delete":               "Triggers on: user deletion",
-		"user.update":               "Triggers on: user update, email creation, email deletion, change of primary email",
-		"user.update.email":         "Triggers on: email creation, email deletion, change of primary email",
-		"user.update.email.create":  "Triggers on: email creation",
-		"user.update.email.delete":  "Triggers on: email deletion",
-		"user.update.email.primary": "Triggers on: change of primary email",
-		"email.send":                "Triggers on: an email was sent or should be sent",
+		"user":                        "Triggers on: user creation, user deletion, user update, email creation, email deletion, change of primary email",
+		"user.create":                 "Triggers on: user creation",
+		"user.delete":                 "Triggers on: user deletion",
+		"user.update":                 "Triggers on: user update, email creation, email deletion, change of primary email",
+		"user.update.email":           "Triggers on: email creation, email deletion, change of primary email",
+		"user.update.email.create":    "Triggers on: email creation",
+		"user.update.email.delete":    "Triggers on: email deletion",
+		"user.update.email.primary":   "Triggers on: change of primary email",
+		"user.update.username":        "Triggers on: username creation, username deletion, change of username",
+		"user.update.username.create": "Triggers on: username creation",
+		"user.update.username.delete": "Triggers on: username deletion",
+		"user.update.username.update": "Triggers on: change of username",
+		"email.send":                  "Triggers on: an email was sent or should be sent",
 	}}
 }
 

diff --git a/backend/flow_api/flow/profile/action_username_create.go b/backend/flow_api/flow/profile/action_username_create.go
@@ -7,6 +7,8 @@ import (
 	"github.com/teamhanko/hanko/backend/flow_api/services"
 	"github.com/teamhanko/hanko/backend/flowpilot"
 	"github.com/teamhanko/hanko/backend/persistence/models"
+	"github.com/teamhanko/hanko/backend/webhooks/events"
+	"github.com/teamhanko/hanko/backend/webhooks/utils"
 )
 
 type UsernameCreate struct {
@@ -93,5 +95,7 @@ func (a UsernameCreate) Execute(c flowpilot.ExecutionContext) error {
 		return fmt.Errorf("could not create audit log: %w", err)
 	}
 
+	utils.NotifyUserChange(deps.HttpContext, deps.Tx, deps.Persister, events.UserUsernameCreate, userModel.ID)
+
 	return c.Continue(shared.StateProfileInit)
 }
diff --git a/backend/flow_api/flow/profile/action_username_delete.go b/backend/flow_api/flow/profile/action_username_delete.go
@@ -6,6 +6,8 @@ import (
 	"github.com/teamhanko/hanko/backend/flow_api/flow/shared"
 	"github.com/teamhanko/hanko/backend/flowpilot"
 	"github.com/teamhanko/hanko/backend/persistence/models"
+	"github.com/teamhanko/hanko/backend/webhooks/events"
+	"github.com/teamhanko/hanko/backend/webhooks/utils"
 )
 
 type UsernameDelete struct {
@@ -72,5 +74,7 @@ func (a UsernameDelete) Execute(c flowpilot.ExecutionContext) error {
 		return fmt.Errorf("could not create audit log: %w", err)
 	}
 
+	utils.NotifyUserChange(deps.HttpContext, deps.Tx, deps.Persister, events.UserUsernameDelete, userModel.ID)
+
 	return c.Continue(shared.StateProfileInit)
 }
diff --git a/backend/flow_api/flow/profile/action_username_update.go b/backend/flow_api/flow/profile/action_username_update.go
@@ -7,6 +7,8 @@ import (
 	"github.com/teamhanko/hanko/backend/flow_api/services"
 	"github.com/teamhanko/hanko/backend/flowpilot"
 	"github.com/teamhanko/hanko/backend/persistence/models"
+	"github.com/teamhanko/hanko/backend/webhooks/events"
+	"github.com/teamhanko/hanko/backend/webhooks/utils"
 )
 
 type UsernameUpdate struct {
@@ -98,5 +100,7 @@ func (a UsernameUpdate) Execute(c flowpilot.ExecutionContext) error {
 		return fmt.Errorf("could not create audit log: %w", err)
 	}
 
+	utils.NotifyUserChange(deps.HttpContext, deps.Tx, deps.Persister, events.UserUsernameUpdate, userModel.ID)
+
 	return c.Continue(shared.StateProfileInit)
 }
diff --git a/backend/flow_api/flow/shared/hook_email_persist_verified_status.go b/backend/flow_api/flow/shared/hook_email_persist_verified_status.go
@@ -7,6 +7,8 @@ import (
 	auditlog "github.com/teamhanko/hanko/backend/audit_log"
 	"github.com/teamhanko/hanko/backend/flowpilot"
 	"github.com/teamhanko/hanko/backend/persistence/models"
+	"github.com/teamhanko/hanko/backend/webhooks/events"
+	"github.com/teamhanko/hanko/backend/webhooks/utils"
 )
 
 type EmailPersistVerifiedStatus struct {
@@ -116,6 +118,8 @@ func (h EmailPersistVerifiedStatus) Execute(c flowpilot.HookExecutionContext) er
 		if err != nil {
 			return fmt.Errorf("could not create audit log: %w", err)
 		}
+
+		utils.NotifyUserChange(deps.HttpContext, deps.Tx, deps.Persister, events.UserEmailCreate, userId)
 	}
 
 	return nil

diff --git a/backend/flow_api/flow/user_details/action_set_username.go b/backend/flow_api/flow/user_details/action_set_username.go
@@ -7,6 +7,8 @@ import (
 	"github.com/teamhanko/hanko/backend/flow_api/services"
 	"github.com/teamhanko/hanko/backend/flowpilot"
 	"github.com/teamhanko/hanko/backend/persistence/models"
+	"github.com/teamhanko/hanko/backend/webhooks/events"
+	"github.com/teamhanko/hanko/backend/webhooks/utils"
 )
 
 type UsernameSet struct {
@@ -65,5 +67,7 @@ func (a UsernameSet) Execute(c flowpilot.ExecutionContext) error {
 
 	c.PreventRevert()
 
+	utils.NotifyUserChange(deps.HttpContext, deps.Tx, deps.Persister, events.UserUsernameCreate, userID)
+
 	return c.Continue()
 }
diff --git a/backend/webhooks/events/events.go b/backend/webhooks/events/events.go
@@ -5,14 +5,18 @@ import "github.com/teamhanko/hanko/backend/persistence/models"
 type Event string
 
 const (
-	User             Event = "user"
-	UserCreate       Event = "user.create"
-	UserUpdate       Event = "user.update"
-	UserDelete       Event = "user.delete"
-	UserEmail        Event = "user.update.email"
-	UserEmailCreate  Event = "user.update.email.create"
-	UserEmailPrimary Event = "user.update.email.primary"
-	UserEmailDelete  Event = "user.update.email.delete"
+	User               Event = "user"
+	UserCreate         Event = "user.create"
+	UserUpdate         Event = "user.update"
+	UserDelete         Event = "user.delete"
+	UserEmail          Event = "user.update.email"
+	UserEmailCreate    Event = "user.update.email.create"
+	UserEmailPrimary   Event = "user.update.email.primary"
+	UserEmailDelete    Event = "user.update.email.delete"
+	UserUsername       Event = "user.update.username"
+	UserUsernameCreate Event = "user.update.username.create"
+	UserUsernameDelete Event = "user.update.username.delete"
+	UserUsernameUpdate Event = "user.update.username.update"
 
 	EmailSend Event = "email.send"
 )
@@ -25,7 +29,7 @@ func StringIsValidEvent(value string) bool {
 func IsValidEvent(evt Event) bool {
 	var isValid bool
 	switch evt {
-	case User, UserCreate, UserUpdate, UserDelete, UserEmail, UserEmailCreate, UserEmailPrimary, UserEmailDelete, EmailSend:
+	case User, UserCreate, UserUpdate, UserDelete, UserEmail, UserEmailCreate, UserEmailPrimary, UserEmailDelete, UserUsername, UserUsernameCreate, UserUsernameUpdate, UserUsernameDelete, EmailSend:
 		isValid = true
 	default:
 		isValid = false