docs: document organization.membership.updated delta payload#1413
Open
simeng-li wants to merge 6 commits into
Open
docs: document organization.membership.updated delta payload#1413simeng-li wants to merge 6 commits into
simeng-li wants to merge 6 commits into
Conversation
Deploying logto-docs with
|
| Latest commit: |
7fa121b
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://1458f242.logto-docs.pages.dev |
| Branch Preview URL: | https://simeng-log-13466-docs-webhoo.logto-docs.pages.dev |
05c68c1 to
1a9ab3d
Compare
Deploying logto-docs-tutorials with
|
| Latest commit: |
7fa121b
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://455793a4.logto-docs-tutorials.pages.dev |
| Branch Preview URL: | https://simeng-log-13466-docs-webhoo.logto-docs-tutorials.pages.dev |
1a9ab3d to
6b19771
Compare
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the webhook documentation to describe the new delta fields on Organization.Membership.Updated payloads (user/application additions/removals) and expands the event catalog to include additional triggers/routes (including applications membership routes, invitation acceptance, and JIT provisioning).
Changes:
- Documented optional top-level delta arrays for
Organization.Membership.Updatedpayloads, including triggers-to-fields mapping and examples. - Expanded “Management API triggered events” tables to include
/organizations/:id/applicationsroutes and invitation acceptance. - Added
Organization.Membership.Updatedas an Experience API trigger for JIT provisioning and linked event docs to the new payload section.
Reviewed changes
Copilot reviewed 20 out of 20 changed files in this pull request and generated 11 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/developers/webhooks/request.mdx | Adds a dedicated Organization.Membership.Updated payload section with delta arrays, caps, and examples. |
| docs/developers/webhooks/events.mdx | Updates org membership event description and adds missing trigger routes (apps + invitation acceptance) and JIT trigger. |
| i18n/zh-TW/docusaurus-plugin-content-docs/current/developers/webhooks/request.mdx | zh-TW localization of the updated request/payload documentation. |
| i18n/zh-TW/docusaurus-plugin-content-docs/current/developers/webhooks/events.mdx | zh-TW localization of updated event tables and membership event description/link. |
| i18n/zh-CN/docusaurus-plugin-content-docs/current/developers/webhooks/request.mdx | zh-CN localization of the updated request/payload documentation. |
| i18n/zh-CN/docusaurus-plugin-content-docs/current/developers/webhooks/events.mdx | zh-CN localization of updated event tables and membership event description/link. |
| i18n/th/docusaurus-plugin-content-docs/current/developers/webhooks/events.mdx | Thai localization updates to event tables and added membership triggers/JIT row. |
| i18n/pt-BR/docusaurus-plugin-content-docs/current/developers/webhooks/request.mdx | pt-BR localization of the updated request/payload documentation. |
| i18n/pt-BR/docusaurus-plugin-content-docs/current/developers/webhooks/events.mdx | pt-BR localization of updated event tables and membership event description/link. |
| i18n/ko/docusaurus-plugin-content-docs/current/developers/webhooks/request.mdx | Korean localization of the updated request/payload documentation. |
| i18n/ko/docusaurus-plugin-content-docs/current/developers/webhooks/events.mdx | Korean localization of updated event tables and membership event description/link. |
| i18n/ja/docusaurus-plugin-content-docs/current/developers/webhooks/events.mdx | Japanese localization of updated event tables and membership event description/link. |
| i18n/fr/docusaurus-plugin-content-docs/current/developers/webhooks/request.mdx | French localization of the updated request/payload documentation. |
| i18n/fr/docusaurus-plugin-content-docs/current/developers/webhooks/events.mdx | French localization of updated event tables and membership event description/link. |
| i18n/es/docusaurus-plugin-content-docs/current/developers/webhooks/request.mdx | Spanish localization of the updated request/payload documentation. |
| i18n/es/docusaurus-plugin-content-docs/current/developers/webhooks/events.mdx | Spanish localization of updated event tables and membership event description/link. |
| i18n/de/docusaurus-plugin-content-docs/current/developers/webhooks/request.mdx | German localization of the updated request/payload documentation. |
| i18n/de/docusaurus-plugin-content-docs/current/developers/webhooks/events.mdx | German localization of updated event tables and membership event description/link. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
charIeszhao
approved these changes
May 22, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Refs LOG-13466. Documents the
addedUserIds/removedUserIds/addedApplicationIds/removedApplicationIdsfields landed onOrganization.Membership.Updatedin Phases 1–3 (logto-io/logto#8833, #8834, #8836), plus the cross-cutting payload contracts that apply to every membership trigger.What changed
docs/developers/webhooks/events.mdxOrganization.Membership.Updatedrow in the Organization event table to call out user vs. application membership and link to the new payload subsection inrequest.mdx./applicationsroutes plus invitation-accept (PUT /organization-invitations/:id/status).Organization.Membership.Updated.docs/developers/webhooks/request.mdxOrganization.Membership.Updatedrow in the data-payload table to a new dedicated subsection.#### Organization.Membership.Updated payloadsubsection covering: the four optional delta arrays as top-level payload fields, a triggers-vs-fields table, the omit-empty rule (absent ≠ empty change), the 5000-entry silent-truncation cap with Management-API reconciliation guidance, the consumer-side filter pattern for skipping no-op events, and five worked example payloads (add, replace, remove, no-op, capped).Expected result
Organization.Membership.Updatedand the exact payload shape consumers can expect.data: nullfield is unchanged, and field absence means "no change on that side."Testing
N/A
Checklist