Skip to content

docs: document organization.membership.updated delta payload#1413

Open
simeng-li wants to merge 6 commits into
masterfrom
simeng-log-13466-docs-webhook-reference-for-organizationmembershipupdated
Open

docs: document organization.membership.updated delta payload#1413
simeng-li wants to merge 6 commits into
masterfrom
simeng-log-13466-docs-webhook-reference-for-organizationmembershipupdated

Conversation

@simeng-li
Copy link
Copy Markdown
Contributor

Summary

Refs LOG-13466. Documents the addedUserIds / removedUserIds / addedApplicationIds / removedApplicationIds fields landed on Organization.Membership.Updated in 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.mdx
    • Rewrote the Organization.Membership.Updated row in the Organization event table to call out user vs. application membership and link to the new payload subsection in request.mdx.
    • Added four missing Management-API rows: the three /applications routes plus invitation-accept (PUT /organization-invitations/:id/status).
    • Added a row to the Experience-API table for just-in-time provisioning (email-domain JIT and enterprise-SSO JIT), which is now a documented trigger of Organization.Membership.Updated.
  • docs/developers/webhooks/request.mdx
    • Linked the existing Organization.Membership.Updated row in the data-payload table to a new dedicated subsection.
    • Added a new #### Organization.Membership.Updated payload subsection 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

  • The webhook reference now describes every shipped trigger of Organization.Membership.Updated and the exact payload shape consumers can expect.
  • Strict-schema consumers have explicit guidance: the new fields are optional and additive, the legacy data: null field is unchanged, and field absence means "no change on that side."
  • Bulk-operation consumers know the 5000-entry cap is silent and that an array of exactly 5000 entries is the cue to reconcile via the Management API.

Testing

N/A

Checklist

  • `.changeset`
  • unit tests
  • integration tests
  • necessary TSDoc comments

@cloudflare-workers-and-pages
Copy link
Copy Markdown

cloudflare-workers-and-pages Bot commented May 21, 2026

Deploying logto-docs with  Cloudflare Pages  Cloudflare Pages

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

View logs

@simeng-li simeng-li force-pushed the simeng-log-13466-docs-webhook-reference-for-organizationmembershipupdated branch from 05c68c1 to 1a9ab3d Compare May 21, 2026 07:32
@cloudflare-workers-and-pages
Copy link
Copy Markdown

cloudflare-workers-and-pages Bot commented May 21, 2026

Deploying logto-docs-tutorials with  Cloudflare Pages  Cloudflare Pages

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

View logs

@simeng-li simeng-li force-pushed the simeng-log-13466-docs-webhook-reference-for-organizationmembershipupdated branch from 1a9ab3d to 6b19771 Compare May 21, 2026 07:46
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.Updated payloads, including triggers-to-fields mapping and examples.
  • Expanded “Management API triggered events” tables to include /organizations/:id/applications routes and invitation acceptance.
  • Added Organization.Membership.Updated as 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.

Comment thread docs/developers/webhooks/request.mdx Outdated
Comment thread i18n/zh-CN/docusaurus-plugin-content-docs/current/developers/webhooks/request.mdx Outdated
Comment thread i18n/zh-TW/docusaurus-plugin-content-docs/current/developers/webhooks/request.mdx Outdated
Comment thread i18n/pt-BR/docusaurus-plugin-content-docs/current/developers/webhooks/request.mdx Outdated
Comment thread i18n/ko/docusaurus-plugin-content-docs/current/developers/webhooks/request.mdx Outdated
Comment thread i18n/es/docusaurus-plugin-content-docs/current/developers/webhooks/request.mdx Outdated
Comment thread i18n/de/docusaurus-plugin-content-docs/current/developers/webhooks/request.mdx Outdated
Comment thread i18n/th/docusaurus-plugin-content-docs/current/developers/webhooks/events.mdx Outdated
Comment thread i18n/zh-TW/docusaurus-plugin-content-docs/current/developers/webhooks/request.mdx Outdated
Comment thread i18n/zh-CN/docusaurus-plugin-content-docs/current/developers/webhooks/request.mdx Outdated
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

3 participants