User Registration Create Event

Edit on GitHubView Markdown
On this page

User Registration Create

Available since 1.6.0

This event is generated when a user registration is created.

The final state of the operation which caused the webhook is not persisted to FusionAuth until after the webhook finishes; learn more.

Event type

user.registration.create

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 transactional. The final state of the operation which caused the webhook is not persisted to FusionAuth until after the webhook finishes; learn more

Event Body

event.applicationId
  • Type: UUID

The unique Id of the Application for which the user has now been registered.

event.createInstant
  • Type: Long

The instant that the event was generated.

event.id
  • Type: 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
  • Type: Object
  • Available since 1.30.0

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

event.info.deviceDescription
  • Type: String
  • Available since 1.30.0

The description of the device associated with the event.

event.info.deviceName
  • Type: String
  • Available since 1.30.0

The device name associated with the event.

event.info.deviceType
  • Type: String
  • Available since 1.30.0

The type of device associated with the event.

event.info.ipAddress
  • Type: String
  • Available since 1.27.0

The source IP address of the event.

event.info.location.city
  • Type: String
  • Available since 1.30.0

The city where the event originated.

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

event.info.location.country
  • Type: String
  • Available since 1.30.0

The country where the event originated.

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

event.info.location.latitude
  • Type: Double
  • Available since 1.30.0

The latitude where the event originated.

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

event.info.location.longitude
  • Type: Double
  • Available since 1.30.0

The longitude where the event originated.

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

event.info.location.region
  • Type: String
  • Available since 1.30.0

The geographic location where the event originated.

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

event.info.location.zipcode
  • Type: String
  • Available since 1.30.0

The zip code where the event originated.

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

event.info.os
  • Type: String
  • Available since 1.30.0

The operating system associated with the event.

event.info.userAgent
  • Type: String
  • Available since 1.30.0

The user agent associated with the event.

event.registration
  • Type: Object

The user registration that has been created. See the Registration API for property definitions and example JSON.

event.tenantId
  • Type: UUID

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

event.linkedObjectId
  • Type: UUID
  • Available since 1.53.0

The Id of the user impacted by this event.

event.type
  • Type: String

The event type, this value will always be user.registration.create.

event.user
  • Type: Object

The user that owns the new registration. See the Users API for property definitions and example JSON.

Example Event JSON
{
  "applicationId": "fed19281-1584-4db8-8b24-959e2d986904",
  "createInstant": 1505762615056,
  "id": "e502168a-b469-45d9-a079-fd45f83e0406",
  "info": {
    "ipAddress": "42.42.42.42",
    "location": {
      "city": "Denver",
      "country": "US",
      "displayString": "Denver, CO, US",
      "latitude": 39.77777,
      "longitude": -104.9191,
      "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"
  },
  "registration": {
    "applicationId": "10000000-0000-0002-0000-000000000001",
    "id": "00000000-0000-0002-0000-000000000000",
    "insertInstant": 1446064706250,
    "roles": [
      "user"
    ],
    "usernameStatus": "ACTIVE"
  },
  "tenantId": "e872a880-b14f-6d62-c312-cb40f22af465",
  "type": "user.registration.create",
  "user": {
    "active": true,
    "connectorId": "e3306678-a53a-4964-9040-1c96f36dda72",
    "email": "example@fusionauth.io",
    "id": "00000000-0000-0001-0000-000000000000",
    "passwordChangeRequired": false,
    "tenantId": "f24aca2b-ce4a-4dad-951a-c9d690e71415",
    "twoFactorEnabled": false,
    "usernameStatus": "ACTIVE",
    "verified": true
  }
}

Related

Extend

User Registration Create Complete Event

Learn about the User Registration Create Complete event.

registration webhookfusionauth userwebhook event
Extend

User Registration Delete Event

Learn about the User Registration Delete event.

registration webhookfusionauth userwebhook event
Extend

User Registration Delete Complete Event

Learn about the User Registration Delete Complete event.

registration webhookfusionauth userwebhook event
Extend

User Registration Update Event

Learn about the User Registration Update event.

registration webhookfusionauth userwebhook event