Skip to main content

Group channel changed

The group_channel:changed event fires when a group's built-in profile, custom profile, or permission settings are updated. Use this event to keep group metadata in sync on your app server.

For the complete webhook setup and signature verification guide, see Webhooks overview.

Event type

group_channel:changed

Payload

Envelope

FieldTypeRequiredDescription
typeStringYes"group_channel:changed"
idStringYesUnique event ID.
timeLongYesEvent generation time (Unix ms).
dataArrayYesArray containing one group change object. See Data fields.

Data fields

FieldTypeRequiredDescription
profilesArrayYesList of group update records. Each element describes one group that was updated. See profiles[i] fields.

profiles[i] fields

FieldTypeRequiredDescription
channelIdStringYesThe group ID.
channelNameStringYesThe group name at the time of the update.
timeLongYesTime the update was made (Unix ms).
userIdStringNoThe user ID of the person who made the change.
profileObjectNoUpdated built-in group information (e.g., bulletin).
customProfileObjectNoUpdated custom (application-defined) group information.
permissionsObjectNoUpdated group permission configuration.

Example

JSON
{
"type": "group_channel:changed",
"id": "550e8400-e29b-41d4-a716-446655440009",
"time": 1730192400000,
"data": [
{
"profiles": [
{
"channelId": "group_001",
"channelName": "Dev Group",
"time": 1730192400000,
"userId": "user_001",
"profile": {"bulletin": "Welcome"},
"customProfile": {"tags": "dev"},
"permissions": {}
}
]
}
]
}