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; collaborators revert to default.
| Event | Fires when |
|---|---|
role.created | A new role is created within a team. |
role.updated | Role name or abilities change. |
role.deleted | A role is deleted; any collaborators holding it revert to their team's default role. |
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": "tem_01HX...",
"role": {
"id": "rol_01HX...",
"name": "Plan Editor",
"abilities": [
"project-subscription-plan:view-any",
"project-subscription-plan:update"
]
}
}
}Required abilities
Tokens subscribing to role.* events must carry role:view-any.
How is this guide?