User Password Reset Start

Event Scope

Prior to version 1.37.0 this was a tenant scoped event. This event will be sent to all tenants that are listening, but will contain a tenantId to allow for filtering.

In version 1.37.0 and later this is also a tenant scoped event. It can be sent to all tenants or to one or more specified tenants. However, those tenants will not be sent events for other tenants, but only events related to themselves.

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: A paid plan is required to utilize event info location.

event.info.location.country [String]

The country where the event originated.

Note: A paid plan is required to utilize event info location.

event.info.location.latitude [String]

The latitude where the event originated.

Note: A paid plan is required to utilize event info location.

event.info.location.longitude [String]

The longitude where the event originated.

Note: A paid plan is required to utilize event info location.

event.info.location.region [String]

The geographic location where the event originated.

Note: A paid plan is required to utilize event info location.

event.info.location.zipcode [String]

The zip code where the event originated.

Note: A paid plan is required to utilize event info location.

event.info.os [String]

The operating system associated with the event.

event.info.userAgent [String]

The user agent associated with the event.

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.password.reset.start.

event.user [Object]

The user that the reset password flow has been started for. See the Users API for property definitions and example JSON.

{
  "event" : {
    "createInstant" : 1629437064077,
    "id" : "b7f9135a-c501-4719-af9c-a6c8ca11e60d",
    "info" : {
      "ipAddress": "63.239.150.2",
      "location": {
        "city": "Denver",
        "country": "US",
        "displayString": "Denver, CO, US",
        "latitude": 39.73915,
        "longitude": -104.9847,
        "region": "CO"
      },
      "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"
    },
    "tenantId" : "30663132-6464-6665-3032-326466613934",
    "type" : "user.password.reset.start",
    "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
    }
  }
}