group.members_synced
The set of people in a group changed, with the deltas.
When this fires
The membership of a group is replaced and the result differs from what was there before, via the group members endpoint or the dashboard's group editor.
A group carries permissions, so who is in it decides who can do what. Until this event existed, renaming a group announced itself with group.updated while changing who it granted access to announced nothing at all; an integration mirroring access control could see the label change and miss the membership.
A no-op sync is silent. Syncing the same set that is already there emits nothing. This event means the membership actually moved, so receiving one always implies at least one id in
added_idsorremoved_ids.
Why the deltas are in the payload
An access-control mirror needs to know who lost the group, and diffing two snapshots on the far side is work it should not have to do: it requires having stored the previous state, and gets the answer wrong the first time it sees a group. added_ids and removed_ids are computed where the truth is, from the membership read immediately before the write and the list written immediately after it.
member_ids is still there for consumers that would rather replace their copy than apply a patch. Both are consistent with each other.
Caveats
- This is a replace, not an add. Anyone absent from the request is removed. An empty list empties the group.
- Permissions are not in the payload. What the group grants is a property of the group, not of this event; read it from the group endpoint if your mirror needs the effective permission set.
- Users, not projects. A group clusters collaborators. It is not a way to bundle projects.
- Removal from a group does not remove anyone from the team.
Related events
group.updated: the group was renamed or re-permissioned.group.created: predecessor.group.deleted: terminal state; everyone loses what it granted at once.
Ability to subscribe
A token needs this to subscribe an endpoint to the event.
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.
Payload
JSONWhat Subscriby posts to your endpointapplication/json
The signed JSON envelope posted to your endpoint.
The envelope every event is delivered in.
Responses
2XXAny success status
Your endpoint acknowledged the delivery. Any 2xx status within 30 seconds marks it delivered; the response body is ignored.
defaultAny other status
Any other status, a connection failure, or no answer within 30 seconds counts as a failed attempt. The delivery is retried 8 times, after 10 seconds, 30 seconds, 2 minutes, 10 minutes, 1 hour, 6 hours, 1 day, 3 days; the last failure dead-letters it, and it can be retried from the dashboard or POST /v1/webhook-deliveries/{delivery}/retry. After 20 consecutive failures the endpoint is paused until it is resumed.
How is this guide?
Last updated on