Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add SMS templates docs #4959

Merged
merged 3 commits into from
Jan 24, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
7 changes: 7 additions & 0 deletions en/asgardeo/docs/guides/branding/customize-sms-templates.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{% set product_name = "Asgardeo" %}

{% set notification_templates_api_path = "notification-templates-rest-api" %}

{% set localization_doc_path = "localization" %}

{% include "../../../../includes/guides/branding/customize-sms-templates.md" %}
1 change: 1 addition & 0 deletions en/asgardeo/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -366,6 +366,7 @@ nav:
- Branding AI: guides/branding/ai-branding.md
- Configure custom domains: guides/branding/configure-custom-domains.md
- Customize email templates: guides/branding/customize-email-templates.md
- Customize SMS templates: guides/branding/customize-sms-templates.md
- Localization in Asgardeo: guides/branding/localization.md
- Extend with actions:
- Understanding actions: guides/customize/actions/understanding-actions.md
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{% set product_name = "WSO2 Identity Server" %}

{% set notification_templates_api_path = "notification-templates-rest-api" %}

{% set localization_doc_path = "localization" %}

{% include "../../../../../includes/guides/branding/customize-sms-templates.md" %}
1 change: 1 addition & 0 deletions en/identity-server/next/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -607,6 +607,7 @@ nav:
- Configure UI branding: guides/branding/configure-ui-branding.md
- Customize layouts: guides/branding/add-custom-layouts.md
- Customize email templates: guides/branding/customize-email-templates.md
- Customize SMS templates: guides/branding/customize-sms-templates.md
- Localization support: guides/branding/localization.md
- Extend with actions:
- Understanding actions: guides/customize/actions/understanding-actions.md
Expand Down
8 changes: 4 additions & 4 deletions en/includes/guides/branding/customize-email-templates.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,13 +95,13 @@ You can tailor the **subject**, **body**, and **footer** of email notifications
!!! warning "Apply changes to user profiles"
To apply these changes to each user's profile in your organization:

1. Display the `local` attribute on the user's profile. Learn more on [updating user attributes]({{base_path}}/guides/users/attributes/manage-attributes/#update-attributes).
1. Display the `local` attribute on the user's profile. Learn how to do so in [updating user attributes]({{base_path}}/guides/users/attributes/manage-attributes/#update-attributes).

2. Update the `local` attribute value with the [required locale code]({{base_path}}/guides/branding/{{ localization_doc_path }}/#supported-languages).
2. Update the `local` attribute value with the [required locale code]({{base_path}}/guides/branding/{{ localization_doc_path }}/#supported-languages). The value should be updated by,

- If the admin onboards the user to the organization, the admin is responsible for updating the locale code.
- the admin, if the admin onboards the user to the organization.

- If the user self-registers, they should update the locale code by themselves at the time of registration.
- the user, if the user self-registers to the organization.

Alternatively, you can customize the content of email templates using the [Email Templates API]({{base_path}}/apis/{{ email_templates_api_path }}/) provided by {{ product_name }}.

Expand Down
32 changes: 32 additions & 0 deletions en/includes/guides/branding/customize-sms-templates.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# Customize SMS templates

The following topics explain how you can customize SMS notifications that are sent to users of your {{ product_name }} organization.

## Customize SMS content

You can tailor the **body** of SMS notifications to your preferences by following the steps below.

!!! note
This feature is only available for the most frequently used SMS templates. You can customize [all available SMS templates]({{base_path}}/references/sms-templates/) using the [Notification Templates API]({{base_path}}/apis/{{ notificaiton_templates_api_path }}/).

1. On the {{ product_name }}, go to **Branding** > **SMS Templates**.
2. Select the SMS template and the relevant locale that you wish to modify.

![Select SMS template]({{base_path}}/assets/img/guides/branding/select-sms-template.png){: width="600" style="display: block; margin: 0; border: 0.3px solid lightgrey;"}

3. Make your modifications in the **SMS Template Body** input field and use the **Preview** for a real-time preview.

4. Click **Save** to publish your changes.

!!! warning "Apply changes to user profiles"
To apply these changes to each user's profile in your organization:

1. Display the `local` attribute on the user's profile. Learn how to do so in [updating user attributes]({{base_path}}/guides/users/attributes/manage-attributes/#update-attributes).

2. Update the `local` attribute value with the [required locale code]({{base_path}}/guides/branding/{{ localization_doc_path }}/#supported-languages). The value should be updated by,

- the admin, if the admin onboards the user to the organization.

- the user, if the user self-registers to the organization.

Alternatively, you can customize the content of SMS templates using the [Notification Templates API]({{base_path}}/apis/{{ notification_templates_api_path }}/) provided by {{ product_name }}.