group.updated
A group is renamed or its permission set replaced.
When this fires
A group is renamed, or the permissions attached to it are replaced. Who is in the group is a separate event, group.members_synced, because the two changes have different consequences. A rename is cosmetic; changing the permission set silently re-scopes everyone already in the group.
Caveats
- The permission set is not in the payload, so this event tells you a group changed without telling you into what. Read the group endpoint for the current permissions.
- Permissions replace, they do not merge. An update that sends
permissionssets them to exactly that list, so everyone in the group can gain and lose access in the same event. codeis immutable, so a rename never breaks a reference held elsewhere.- Membership is untouched here. See
group.members_synced.
Related events
group.members_synced: who is in the group changed.group.created: predecessor.group.deleted: terminal state.
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