role.* events
Role create / update / delete. Growth-tier only.
Events
role.created
New role created within a team.
role.updated
Role name or abilities change.
role.deleted
Role deleted. Only roles no collaborator currently holds can be deleted.
| Event | Fires when |
|---|---|
role.created | A new role is created within a team. |
role.updated | Role name or abilities change. |
role.deleted | A role that no collaborator currently holds is deleted. |
See the dedicated pages above for full payload, field reference, and caveats per event.
Example payload
{
"id": "evt_01HX...",
"type": "role.updated",
"created_at": "2026-05-18T10:05:00Z",
"api_version": "2026-05-01",
"project_id": null,
"data": {
"team_id": "a83f0d51-4c92-4b7e-8615-2fd9e70a3c86",
"role_id": "d05e1a83-7c46-4f29-b613-8ae407c9d251",
"code": "plan-editor",
"name": "Plan Editor"
}
}Required abilities
Tokens subscribing to role.* events must carry role:view.
How is this guide?