Group Member Add
Group Member Add
This event is generated when one or more users are added to a group. The JSON includes the Group and an array of added members.
Event typegroup.member.add
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.
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 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
LongThe instant that the event was generated.
event.group
ObjectThe group to which members were added. See the Groups API for property definitions and example JSON.
event.id
UUIDThe unique Id of the event.
event.members
ArrayAn array of added group members.
event.info.data
Objectevent.info.deviceDescription
Stringevent.info.deviceName
Stringevent.info.deviceType
Stringevent.info.ipAddress
Stringevent.info.location.city
Stringevent.info.location.country
Stringevent.info.location.latitude
Doubleevent.info.location.longitude
Doubleevent.info.location.region
Stringevent.info.location.zipcode
Stringevent.info.os
Stringevent.info.userAgent
Stringevent.members[x].data
ObjectAn object that can hold any information about the group member.
event.members[x].id
UUIDThe unique Id of this group member. This is not the user Id.
event.members[x].insertInstant
LongThe instant that this membership was created.
event.members[x].userId
UUIDThe user Id of the member.
event.tenantId
UUIDThe unique tenant identifier. This value may not be returned if not applicable.
event.type
StringThe event type, this value will always be group.member.add
.
{
"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.add"
}
}