-
Notifications
You must be signed in to change notification settings - Fork 320
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #4959 from Avarjana/master
Add SMS templates docs
- Loading branch information
Showing
8 changed files
with
52 additions
and
4 deletions.
There are no files selected for viewing
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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" %} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Binary file added
BIN
+29.3 KB
en/identity-server/next/docs/assets/img/guides/branding/select-sms-template.png
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
7
en/identity-server/next/docs/guides/branding/customize-sms-templates.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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" %} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 }}. |