role.updated
A role's name or abilities change.
When this fires
A role's name, description, or permission set is saved, including the default admin, manager and viewer roles. The event is emitted on every save, even one that changes nothing, so treat it as "the role was written" rather than "the role changed".
Caveats
- This event fires on both name changes and ability-set changes; fetch the role from the API to determine what actually changed.
- Collaborators currently holding the role pick up the new abilities immediately on next request.
Related events
role.created: predecessor.team.member.role_changed: fires when a collaborator's role assignment changes (different surface).
Header Parameters
t=<unix seconds>,v1=<hex>: the HMAC-SHA256 of "<t>.<raw body>" under the endpoint's secret. Verify it before acting, and refuse a t more than 300 seconds from now. During a secret rotation a v0= signature under the previous secret may precede v1=.
The event's ULID, bare. The envelope's id is the same ULID prefixed evt_, so strip the prefix before comparing. Deduplicate on it: a retry carries the same id.
The event name, the same as the envelope's type.
Always application/json.
Always Subscriby-Webhooks/1.0.
Request Body
application/json
The signed JSON envelope posted to your endpoint.
TypeScript Definitions
Use the request body type in TypeScript.
The envelope every event is delivered in.
Response Body
Example Requests
/role.updatedHow is this guide?