Group Member Update Complete Event

Edit on GitHubView Markdown
On this page

Group Member Update Complete

Available since 1.38.0

This event is generated when updating members in group. The JSON includes the Group and an array of current members.

Event type

group.member.update.complete

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 non-transactional. The operation will succeed regardless of the webhook response status code.

Event Body

event.createInstant
  • Type: Long

The instant that the event was generated.

event.group
  • Type: Object

The group in which members were updated. 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 impacted by this event.

event.members
  • Type: Array

An array of updated group members.

event.members[x].data
  • Type: Object

An object that can hold any information about the group member.

event.members[x].id
  • Type: UUID

The unique Id of this group member. This is not the user Id.

event.members[x].insertInstant
  • Type: Long

The instant that this membership was created.

event.members[x].userId
  • Type: UUID

The user Id of the member.

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.member.update.complete.

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)"
    },
    "members": [
      {
        "data": {
          "foo": "bar"
        },
        "id": "dd31009e-cf02-44d7-b025-1ca90bc14fdf",
        "insertInstant": 1660777395226,
        "userId": "8696203c-4bae-42f2-ab1d-0eabbd5fb2d6"
      }
    ],
    "tenantId": "f84cfebc-d68f-4b8c-9014-f9afa6ccc3e1",
    "type": "group.member.update.complete"
  }
}

Related

Extend

Group Member Add Event

Learn about the Group Member Add event.

group webhookfusionauth groupswebhook event
Extend

Group Member Add Complete Event

Learn about the Group Member Add Complete event.

group webhookfusionauth groupswebhook event
Extend

Group Member Remove Event

Learn about the Group Member Remove event.

group webhookfusionauth groupswebhook event
Extend

Group Member Remove Complete Event

Learn about the Group Member Remove Complete.

group webhookfusionauth groupswebhook event