Resources
🤖 For AI agents: The complete documentation index is available at /docs/llms.txt. A markdown version of this page is available at /docs/extend/events-and-webhooks/events/user/user-email-update.md.

Email Update

Edit on GitHub
View Markdown
note

For a more general event that covers updates to both email addresses and phone numbers, see User Identity Verified.

User Email Update

version
This event has been available since 1.30.0

This event is generated when a user updates their email address.

Event type
user.email.update

Event Scope

This is a tenant scoped event.

Prior to version 1.37.0 this event was sent to all webhooks, and it was a webhook's responsibility to filter on the tenantId field.

In version 1.37.0 and later, this event will only be sent to tenants for which webhooks for this event are enabled.

Transaction Compatibility

This event is non-transactional. The operation will succeed regardless of the webhook response status code.

Event Body

event.createInstant Long

The instant that the event was generated.

event.id UUID

The unique Id of the event. You may receive an event more than once based upon your transaction settings. This Id may be used to identify a duplicate event.

event.info.data Object

An object that can hold any information about the event that should be persisted.

event.info.deviceDescription String

The description of the device associated with the event.

event.info.deviceName String

The device name associated with the event.

event.info.deviceType String

The type of device associated with the event.

event.info.ipAddress String

The source IP address of the event.

event.info.location.city String

The city where the event originated.

Note: To use event location data, you'll need an Enterprise plan.

event.info.location.country String

The country where the event originated.

Note: To use event location data, you'll need an Enterprise plan.

event.info.location.latitude Double

The latitude where the event originated.

Note: To use event location data, you'll need an Enterprise plan.

event.info.location.longitude Double

The longitude where the event originated.

Note: To use event location data, you'll need an Enterprise plan.

event.info.location.region String

The geographic location where the event originated.

Note: To use event location data, you'll need an Enterprise plan.

event.info.location.zipcode String

The zip code where the event originated.

Note: To use event location data, you'll need an Enterprise plan.

event.info.os String

The operating system associated with the event.

event.info.userAgent String

The user agent associated with the event.

event.linkedObjectId UUID Available since 1.53.0

The Id of the user impacted by this event.

event.previousEmail String

The last value of the user's email address.

event.tenantId UUID

The unique tenant identifier. This value may not be returned if not applicable.

event.type String

The event type, this value will always be user.email.update.

event.user Object

The user that has updated their email address. See the Users API for property definitions and example JSON.

Example Event JSON

{
  "event": {
    "createInstant": 1629436495546,
    "id": "5de8b625-9465-4ecf-b063-e819fc48cbc9",
    "info": {
      "ipAddress": "71.229.161.136",
      "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/92.0.4515.131 Safari/537.36"
    },
    "previousEmail": "dinesh@fusionauth.io",
    "type": "user.email.update",
    "user": {
      "active": true,
      "birthDate": "1981-06-04",
      "connectorId": "e3306678-a53a-4964-9040-1c96f36dda72",
      "data": {
        "Company": "Aviato",
        "foobar": "baz",
        "user_type": "iconoclast"
      },
      "email": "admin@fusionauth.io",
      "firstName": "Erlich",
      "id": "9ea5b4b6-14df-44af-8a5e-c6e4bcb31ced",
      "insertInstant": 1625783576299,
      "lastLoginInstant": 1629232057071,
      "lastName": "Bachman",
      "lastUpdateInstant": 1628024498202,
      "passwordChangeRequired": false,
      "passwordLastUpdateInstant": 1625783576327,
      "tenantId": "a743e2cd-55bb-789c-b076-8846fdd3a51f",
      "twoFactor": {},
      "usernameStatus": "ACTIVE",
      "verified": true
    }
  }
}