subteam_updated event

An existing User Group has been updated or its members changed

Compatibility: RTM Events API

Expected scopes:

    "type": "subteam_updated",
    "subteam": {
        "id": "S516MPG9X",
        "team_id": "T0GMXV71T",
        "is_usergroup": true,
        "is_subteam": true,
        "name": "My User Group Test",
        "description": "User Group Test,
        "handle": "user-group-test",
        "is_external": false,
        "date_create": 1492655498,
        "date_update": 1595814882,
        "date_delete": 0,
        "auto_type": null,
        "auto_provision": false,
        "enterprise_subteam_id": "",
        "created_by": "U0GN26UBG",
        "updated_by": "U0GN26UBG",
        "deleted_by": null,
        "prefs": {
            "channels": [
            "groups": []
        "users": [
        "user_count": 7,
        "channel_count": 0

The subteam_updated event is sent to all connections for a workspace when an existing User Group is updated. This event is triggered for changes to the User Group information (name, description, or handle) as well as the members of the group. Clients can use this to update their local list of groups and group members. The users field is truncated at 500, however the user_count field will still show the actual count.

If you are only interested in User Group membership changes, consider using the subteam_members_changed event instead.

This event type may also arise when a subteam has been disabled.

Events API compatibility

Subscribe to this event via the Events API.

Events of this type will be wrapped in metadata when sent via the Events API.

Was this page helpful?