Skip to main content

Next.js — Group

Associate users with groups (e.g. company, organization) and set group properties. Available on both client and server.

Client: useSignalGroup

Use the same hook as the React integration, re-exported from @signal-js/nextjs/client:

Client: group(groupType, groupKey, properties?)

Associate the current user with a group. Optionally set group properties.

Client: getGroups()

Get all groups the user is currently associated with. Returns an array of group objects.

Server: group(distinctId, groupType, groupKey, properties?, sessionId?, windowId?)

Associate a user with a group from the server. Pass sessionId and windowId for client correlation.

Server: groupIdentify(options, sessionId?, windowId?)

Set or update group properties from the server. Pass sessionId and windowId for client correlation.

See also