Group Create Event

Edit on GitHubView Markdown
On this page

Group Create

Available since 1.38.0

This event is generated when a single group is created. The JSON includes the Group that was created.

Event type

group.create

Event Scope

This is 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 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.createInstant
  • Type: Long

The instant that the event was generated.

event.group
  • Type: Object

The group that has been created. See the Groups API for property definitions and example JSON.

event.id
  • Type: UUID

The unique Id of the event.

event.info.data
  • Type: Object

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

event.info.deviceDescription
  • Type: String

The description of the device associated with the event.

event.info.deviceName
  • Type: String

The device name associated with the event.

event.info.deviceType
  • Type: String

The type of device associated with the event.

event.info.ipAddress
  • Type: String

The source IP address of the event.

event.info.location.city
  • Type: String

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

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

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

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

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

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

The operating system associated with the event.

event.info.userAgent
  • Type: String

The user agent associated with the event.

event.linkedObjectId
  • Type: UUID
  • Available since 1.53.0

The Id of the group created by this event.

event.tenantId
  • Type: UUID

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

event.type
  • Type: String

The event type, this value will always be group.create.

Example Event JSON
{
  "event": {
    "createInstant": 1660777395126,
    "group": {
      "data": {},
      "id": "89450cd0-24a9-401d-a6ad-4116de45b8e2",
      "insertInstant": 1660777395126,
      "lastUpdateInstant": 1660777395156,
      "name": "Employees",
      "roles": {},
      "tenantId": "f84cfebc-d68f-4b8c-9014-f9afa6ccc3e1"
    },
    "id": "2ed2a35c-eff5-41b4-822d-ba1b85d814c4",
    "info": {
      "ipAddress": "127.0.0.1",
      "userAgent": "Restify (https://github.com/inversoft/restify)"
    },
    "tenantId": "f84cfebc-d68f-4b8c-9014-f9afa6ccc3e1",
    "type": "group.create"
  }
}

Related

Extend

Group Create Complete Event

Learn about the Group Create Complete event.

group webhookfusionauth groupswebhook event
Extend

Group Delete Event

Learn about the Group Delete event.

group webhookfusionauth groupswebhook event
Extend

Group Delete Complete Event

Learn about the Group Delete Complete event.

group webhookfusionauth groupswebhook event
Extend

Group Update Event

Learn about the Group Update event.

group webhookfusionauth groupswebhook event