Group

The group call allows you to link an identified user with a group, such as a company, organization, or an account. It also lets you record any custom traits associated with that group, such as the name of the company, the number of employees, etc.

An identified user can be a part of more than one group.

Sample payload

A sample payload for the group event after removing the Common Fields is as shown:

{
"type": "group",
"groupId": "12345",
"traits": {
"name": "MyGroup",
"industry": "IT",
"employees": 450,
"plan": "basic"
}
}

The corresponding event that generates the above payload via the JavaScript SDK is shown below:

rudderanalytics.group("12345", {
name: "MyGroup",
industry: "IT",
employees: 450,
plan: "basic"
})

Group fields

The group call has the following fields in addition to the Common Fields:

FieldTypePresenceDescription
groupIdStringRequiredYour group's unique identifier which lets you identify the group in your database.
traitsObjectOptionalIncludes the traits of the group such as name, email, employees, etc. For more more information, check the Traits section below.

Traits

Traits are bits of information included in an group call that add more context to the group. Some example of traits include the number of employees in the group, name of the industry the group is a part of, or the website of the group.

RudderStack has some reserved traits that it handles in special ways. These are listed in the table below:

TraitTypeDescription
idStringThe group's unique ID.
nameStringThe group name.
emailStringThe group's email address.
phoneStringPhone number associated with the group
addressObject

The group's street address. This can optionally contain either/all of the following fields:

  • city
  • country
  • postalCode
  • state
  • street
industryString

The name of the industry that the group is a part of.

createdAtDate

Date of the group's account creation. We recommend using the ISO-8601 date string format.

descriptionStringThe group's description.
employeesString

Number of the employees in the group. This is typically used for companies.

planStringThe plan that the group is subscribed to.
websiteStringThe group's website.
avatarStringURL of the group's avatar image.

Contact us

For more information on any of the sections covered in this doc, you can contact us or start a conversation in our Slack community.

Contents