Skip to content

Latest commit

 

History

History
34 lines (28 loc) · 1.07 KB

session-views.md

File metadata and controls

34 lines (28 loc) · 1.07 KB

Web pages for the 3PID sessions

You can customize the various pages used during a 3PID validation using the options below.

Configuration

Pseudo-configuration to illustrate the structure:

# CONFIGURATION EXAMPLE
# DO NOT COPY/PASTE THIS IN YOUR CONFIGURATION
view:
  session:
    onTokenSubmit:
      success: '/path/to/session/tokenSubmitSuccess-page.html'
      failure: '/path/to/session/tokenSubmitFailure-page.html'
# CONFIGURATION EXAMPLE
# DO NOT COPY/PASTE THIS IN YOUR CONFIGURATION

view.session: This is triggered when a user submit a validation token for a 3PID session. It is typically visited when clicking the link in a validation email.

The template should typically inform the user that the validation was successful and to go back in their Matrix client to finish the validation process, or that the validation failed.

Two configuration keys are available that accept paths to HTML templates:

  • success
  • failure

Placeholders

Success

No object/placeholder are currently available.

Failure

No object/placeholder are currently available.