feat: add docs for client side events in elements by jonas-jonas · Pull Request #2498 · ory/docs

jonas-jonas · 2026-04-02T14:35:00Z

Checklist

I have read the contributing guidelines and signed the CLA.
I have referenced an issue containing the design document if my change introduces a new feature.
I have read the security policy.
I confirm that this pull request does not address a security vulnerability.
If this pull request addresses a security vulnerability,
I confirm that I got approval (please contact security@ory.com) from the maintainers to push the changes.
I have added tests that prove my fix is effective or that my feature works.
I have added the necessary documentation within the code base (if appropriate).

Further comments

unatasha8

Need to add this file to sidebar file to show location of this new page.

jonas-jonas · 2026-04-02T18:58:46Z

Need to add this file to sidebar file to show location of this new page.

It's automatic for this folder

Co-authored-by: unatasha8 <una.cogavin@ory.sh> Co-authored-by: Jonas Hungershausen <jonas.hungershausen@gmail.com>

unatasha8

LGTM

vinckr · 2026-04-24T15:22:19Z

is this already released?
if yes please fix conflicts and merge, if not please add the upstream label

…ideEvents

Copilot

Pull request overview

Adds a new Ory Elements guide documenting client-side lifecycle events emitted during form submissions, intended to help integrators hook into success/error/validation outcomes.

Changes:

Introduces a new “Lifecycle Events” guide page describing onSuccess, onError, and onValidationError.
Provides example React usage snippets and event payload property tables.
Links to a Matomo tracking example for end-to-end reference.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

* feat: add docs for client side events in elements * Apply suggestions from code review Co-authored-by: unatasha8 <una.cogavin@ory.sh> Co-authored-by: Jonas Hungershausen <jonas.hungershausen@gmail.com> * chore: format * chore: apply suggestion * Potential fix for pull request finding Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> --------- Co-authored-by: unatasha8 <una.cogavin@ory.sh> Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

* docs: adds integration section to top navbar * feat: add community integration stubs under docs/integrates-with Adds 90 community-contributed integration stubs from ory/integrates, organized by vendor category under docs/integrates-with/<category>/<vendor>.mdx, and wires them into sidebars-integrates.ts (27 category sections). For pages that overlap with an existing source-of-truth doc in this repo (Mailchimp via Actions, GitHub sign-in, kratos SMTP and SMS courier pages), the new page leads with a "Primary documentation" admonition linking to the canonical page; see docs/integrates-with/_DUPLICATES.md for the inventory. * docs: remove test files * feat: add generated index links to sidebar categories * docs: fold community email/SMS provider snippets into kratos courier pages Merge the draft provider snippets that were staged under docs/integrates-with into the canonical Ory courier pages: - 01_sending-emails-smtp.mdx: add Brevo, Mailchimp Transactional (Mandrill), and SparkPost as first-class provider entries alongside Sendgrid/Mailgun/SES/Postmark. - 10_sending-sms.mdx: add a Provider examples section with Twilio, MessageBird, Plivo, Sinch, Vonage, and WhatsApp Business request_config examples (the page previously only showed Twilio inline). Removes the now-folded snippet drafts and the _DUPLICATES.md inventory, since the overlaps they tracked are now resolved in-page. * docs: added redirects * docs: add Terraform integration page under integrates-with/iac-devops Add a proper Terraform page for the official ory/ory provider, which had no page in this repo (its canonical docs are external, on the Terraform/OpenTofu registries). Repoint pulumi.mdx's three references from the ory/integrates GitHub URL to the new internal ./terraform.mdx, and add it to the IaC and DevOps sidebar category above Pulumi. * docs: reconcile integrates-with stubs that duplicate first-party pages Per the integrations-team handoff, collapse community stubs that duplicate existing first-party Ory docs: - SMS providers: delete the standalone messagebird/plivo/sinch/twilio/ vonage stubs (now folded into kratos/emails-sms/sending-sms) and drop them from the sidebar. Keep WhatsApp as its own page (custom courier handler, not a plain SMS provider) and point the SMS page's WhatsApp entry at it. - Mailchimp marketing: fold the marketing-audience flow into the existing actions/integrations/mailchimp page as a section (it already covers both subsystems) and delete the cdp-analytics/mailchimp and cdp-analytics/mailchimp-marketing duplicates. - Helm: add a thin integrates-with/iac-devops/helm pointer page with a rel=canonical to the existing hydra/self-hosted Helm chart guide, so the official charts are discoverable under IaC and DevOps without duplicating content. * chore: gitignore Claude Code local files (.claude/docs, worktrees, etc.) * docs: thin canonical-pointer stubs for social sign-in providers Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> * docs: thin canonical-pointer stubs for email and SMS providers * docs: thin stubs for enterprise SSO, generic protocols, and SCIM (per-deployment homes) Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> * docs: thin stubs for Actions-backed integrations and yubikey * docs: full community pages for net-new integrations (README-sourced) Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> * docs: reconcile existing integrates-with pages to thin-stub rule; dedupe salesforce/workday slugs * docs: wire the complete integration catalog into the integrates-with sidebar * docs: apply Ory voice/style pass to integrates-with catalog Apply the ory-docs-voice style guide across the integration catalog: convert telegraphic fragments and arrow-chains into complete second-person sentences, fix terminology (Ory Identities, sign in, self-service flows, set up, Admin API, full product names on first mention), and remove marketing fluff. Thin canonical-pointer stubs were largely already on-voice and left as-is. Preserved: frontmatter, <head> canonical links, admonition types/titles and their links, page types, all link targets/anchors, and the existing /docs/actions links (pending a separate docs-team decision). * fix: update oss docs (#2607) * docs: bump to 8dc0c20ab729fb27c8bf746ee192dbc2fe9b40a4 * fix: enhance dark mode styling for announcement banner (#2610) * chore(docs): update of OEL images (#2596) * chore: h1 policy (#2609) * docs: fix underscores (#2608) * docs: fix underscores * docs: added redirects * feat: document transient payload passthrough in elements (#2499) * feat: document transient payload passthrough in elements * chore: format * Apply suggestions from code review Co-authored-by: Jonas Hungershausen <jonas.hungershausen@gmail.com> * Apply suggestions from code review Co-authored-by: unatasha8 <una.cogavin@ory.sh> --------- Co-authored-by: unatasha8 <una.cogavin@ory.sh> * feat: add docs for client side events in elements (#2498) * feat: add docs for client side events in elements * Apply suggestions from code review Co-authored-by: unatasha8 <una.cogavin@ory.sh> Co-authored-by: Jonas Hungershausen <jonas.hungershausen@gmail.com> * chore: format * chore: apply suggestion * Potential fix for pull request finding Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> --------- Co-authored-by: unatasha8 <una.cogavin@ory.sh> Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> * docs: added docs for scim mapper now receiving identity (#2612) added docs for scim mapper now receiving identity * fix: makefile * chore: warnings about graceful token refresh * feat: add docs for ory elements v1.2 (#2361) * feat: add docs for ory elements v1.2 * Apply suggestions from code review Co-authored-by: Vincent <vincent@ory.sh> * chore: u * chore: u * chore: regnerate type docs * chore: use ProjectConfiguration * chore: u --------- Co-authored-by: Vincent <vincent@ory.sh> * docs: bump to 41024d0730ec0a14ca249c3ee393e1e328b5ec27 * chore(docs): update of OEL images (#2618) chore(docs): update OEL image tag * docs: document pausing event streams Add a "Pause and resume event streams" section to the live event streams guide covering how to pause/resume a stream from the Ory Console, how to create a stream as paused, and what happens to events while a stream is paused. Most importantly, it explains the buffering behavior: while paused, events keep accumulating and are retained for up to 7 days. Resuming within that window delivers the buffered backlog; events older than 7 days are permanently discarded. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> * autogen: update license overview * docs: fix underscore in Learn more link * refactor: format integrates-with docs * fix: update navbar responsiveness breakpoints --------- Co-authored-by: unatasha8 <una.cogavin@ory.sh> Co-authored-by: jhickmanit <jhickman.it@gmail.com> Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com> Co-authored-by: Vincent <vincent@ory.sh> Co-authored-by: aeneasr <3372410+aeneasr@users.noreply.github.com> Co-authored-by: ory-bot <60093411+ory-bot@users.noreply.github.com> Co-authored-by: Jonas Hungershausen <jonas.hungershausen@ory.sh> Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Co-authored-by: Deepak Prabhakara <deepak.prabhakara@ory.sh> Co-authored-by: Arne Luenser <arne.luenser@ory.sh>

feat: add docs for client side events in elements

c9494e0

jonas-jonas requested review from aeneasr, piotrmsc, unatasha8, vinckr and zepatrik as code owners April 2, 2026 14:35

github-actions Bot added the Needs Triage label Apr 2, 2026

ory-bot assigned jonas-jonas Apr 2, 2026

jonas-jonas commented Apr 2, 2026

View reviewed changes

Comment thread docs/elements/guides/20_events.mdx

vercel Bot deployed to Preview April 2, 2026 14:40 View deployment

unatasha8 reviewed Apr 2, 2026

View reviewed changes

jonas-jonas and others added 2 commits April 2, 2026 15:03

Apply suggestions from code review

3798cf9

Co-authored-by: unatasha8 <una.cogavin@ory.sh> Co-authored-by: Jonas Hungershausen <jonas.hungershausen@gmail.com>

chore: format

ce6d1f6

vercel Bot deployed to Preview April 2, 2026 19:10 View deployment

github-actions Bot removed the Needs Triage label Apr 3, 2026

jonas-jonas requested a review from unatasha8 April 3, 2026 19:28

chore: apply suggestion

ef07096

vercel Bot deployed to Preview April 3, 2026 19:34 View deployment

unatasha8 approved these changes Apr 7, 2026

View reviewed changes

Merge remote-tracking branch 'origin/master' into jonas-jonas/clientS…

dd1392e

…ideEvents

Copilot AI review requested due to automatic review settings June 4, 2026 15:33

Copilot started reviewing on behalf of jonas-jonas June 4, 2026 15:33 View session

Copilot AI reviewed Jun 4, 2026

View reviewed changes

Comment thread docs/elements/guides/20_events.mdx

Comment thread docs/elements/guides/20_events.mdx

Comment thread docs/elements/guides/20_events.mdx Outdated

vercel Bot deployed to Preview June 4, 2026 15:40 View deployment

vinckr added the upstream Issue is caused by an upstream dependency. label Jun 8, 2026

Potential fix for pull request finding

88487fd

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

jonas-jonas enabled auto-merge (squash) June 8, 2026 13:09

vercel Bot deployed to Preview June 8, 2026 13:16 View deployment

chore: format

b20c4a0

vercel Bot deployed to Preview June 8, 2026 13:44 View deployment

jonas-jonas merged commit 20cda8f into master Jun 8, 2026
11 checks passed

jonas-jonas deleted the jonas-jonas/clientSideEvents branch June 8, 2026 13:44

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add docs for client side events in elements#2498

feat: add docs for client side events in elements#2498
jonas-jonas merged 7 commits into
masterfrom
jonas-jonas/clientSideEvents

jonas-jonas commented Apr 2, 2026

Uh oh!

Uh oh!

unatasha8 left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

jonas-jonas commented Apr 2, 2026

Uh oh!

unatasha8 left a comment

Uh oh!

vinckr commented Apr 24, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Conversation

jonas-jonas commented Apr 2, 2026

Related Issue or Design Document

Checklist

Further comments

Uh oh!

Uh oh!

unatasha8 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

jonas-jonas commented Apr 2, 2026

Uh oh!

unatasha8 left a comment

Choose a reason for hiding this comment

Uh oh!

vinckr commented Apr 24, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants