CollaboratorGroupRenamed

CollaboratorGroupRenamed fires when an operator changes the display name of an existing collaborator group through the REST API. Only renames trigger this event. Updates that leave the name unchanged are silently skipped so the activity feed stays free of noise.

The event ID is collaborator_group_renamed, and its fully qualified class is Siren\Plus\Core\Groups\Events\CollaboratorGroupRenamed. It is fired by the update-group REST endpoint, so a name changed by another path does not fire it. To run code when it fires, register a handler with Siren’s event system. See listeners and the events introduction.

What does this event carry?

The event carries the group id plus both the previous and the new name. That before/after pair is what lets a listener render a meaningful audit entry without having to re-query the datastore for prior state.

use PHPNomad\Events\Interfaces\CanHandle;
use PHPNomad\Events\Interfaces\Event;
use Siren\Plus\Core\Groups\Events\CollaboratorGroupRenamed;

class HandleGroupRename implements CanHandle
{
    public function handle(Event $event): void
    {
        if (!$event instanceof CollaboratorGroupRenamed) {
            return;
        }

        $groupId = $event->getGroupId();
        $previous = $event->getPreviousName();
        $next = $event->getNewName();

        // e.g. "Renamed 'Affiliate Tier 1' to 'Gold Affiliates'"
    }
}

How does it fit?

Renames are a low-stakes lifecycle event. They don’t disturb members, bindings, or cascade behavior. The most common listener is the activity feed. External integrations that mirror Siren state into another system (a CRM, a data warehouse) listen here to keep their copy of the name in sync.

A single update request can change the name, the description, and the structure at once, and each change fires its own event. So a rename made in the same request as a structure change fires both this event and CollaboratorGroupStructureChanged. Handle them independently.

Related events

CollaboratorGroupCreated, CollaboratorGroupStructureChanged, and CollaboratorGroupDeleted cover the rest of the group’s lifecycle. The collaborator group events reference lists the full family.