Skip to content

fix: transient payload example#2650

Open
vinckr wants to merge 5 commits into
masterfrom
vinckr/docs-janitor-0072
Open

fix: transient payload example#2650
vinckr wants to merge 5 commits into
masterfrom
vinckr/docs-janitor-0072

Conversation

@vinckr

@vinckr vinckr commented Jun 29, 2026

Copy link
Copy Markdown
Member

Related Issue or Design Document

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

@vinckr vinckr requested a review from aeneasr as a code owner June 29, 2026 10:36
Copilot AI review requested due to automatic review settings June 29, 2026 10:36
@vinckr vinckr requested a review from unatasha8 as a code owner June 29, 2026 10:36

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Improves Ory Kratos email/SMS documentation by making the HTTP courier payload and template-type lists track the upstream Kratos source, and by expanding the guidance/examples around transient_payload usage in email templates.

Changes:

  • Embed upstream Kratos source snippets via CodeFromRemote for the HTTP delivery ctx model and template type constants.
  • Add a new “Events that trigger an email” section + an additional template-variable tab (verifiable_address_changed).
  • Add a worked example showing how to pass brand/language via transient_payload into template links, and cross-link it from the “Bring your own UI” guide.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.

File Description
docs/kratos/emails-sms/05_custom-email-templates.mdx Adds template-type source embed, event/condition table, clarifications on authoritative fields, and a new transient payload example.
docs/kratos/emails-sms/01_sending-emails-smtp.mdx Adds ctx payload definition and example Jsonnet template as upstream-synced embeds, plus a hand-maintained field table.
docs/kratos/bring-your-own-ui/05_custom-ui-basic-integration.mdx Adds a link pointing readers to the transient payload email-template example.

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

Comment thread docs/kratos/emails-sms/05_custom-email-templates.mdx Outdated
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants