Community Manager Notifications: Users
Information about email and Dashboard notifications in the Community Manager developer portal, for user events such as signup.
Table of Contents
- Sign Up (New Member Invite)
- Welcome: to new registered user
- Welcome: to new user invited to be an Administrator, when a new tenant is created
- Password Reset
- Password Reset (User never logged in)
- Invitation to Sign Up: Password Reset Request: User Never Signed In
- Invitation to Sign Up: Password Reset Request: User Account Disabled
- Invitation to Sign Up: Password Reset Request by Unregistered User
- Invitation to Sign Up: Password Reset Request by Non-Local User
- Signup Attempt: Account Already Exists (Local Account)
- Contact Support
- Create Post (API)
- Invitation to Sign Up
- Invitation to Sign Up When User Already Exists
- Signup Attempt When User Already Exists
- User Deleted by Site Admin: To User: Signup State = Registered
- User Deleted by Site Admin: To User: Signup State = pending_validation
- User Deleted by Site Admin: To User: Signup State = inviteduser
- User Added by Site Admin: To User
- User Added by Site Admin: First Login: to Site Admin
- User Account Status Change: User Enabled
- User Account Status Change: User Disabled
- User Account Status Change: User Locked
- User Account Status Change: User Unlocked
- User Account Status Change (for Admins)
- Email Notification with 2FA authentication code
- User added by Site Admin: Notification to user on account activation
- Email address has been changed (third-party email address change) (2020.1.0 and later)
- Email address has been changed by a site administrator (third-party email address change) (2020.1.0 and later)
Sign Up (New Member Invite)
Values
- Notification Type
- com.soa.notification.type.signup
- Trigger
- New user registers at signup page
- Recipients (1)
- User who registered
- Notification Category
- None.
- Dashboard Subject
- None; email only
- Dashboard Content
- None; email only
- Email Subject
- {tenant.name} Notification: Signup Confirmation
- Email Body
<p>{user.firstname} {user.lastname}, thank you for signing up at {tenant.name}. To activate your new account, please click the link below. You can also just copy and paste the link into your browser.</p> <p><a href="{tenant.theme.console.address}#/signupconfirm/{signup.code}">{tenant.theme.console.address}#/signupconfirm/{signup.code}</a></p> <p>If you need help, feel free to contact us at {tenant.contact.email}.</p> <p>Thanks,<br/> The {tenant.name} Team</p> {system.email.footer.html}
Welcome: to new registered user
Values
- Notification Type
- com.soa.notification.type.welcome
- Trigger
- User validates email address after signup
- Recipients (1)
- User who registered
- Notification Category
- None.
- Dashboard Subject
- Welcome to {tenant.name}
- Dashboard Content
- The notification panel will show you all your unacknowledged notifications. Notifications are created when there are updates on posts and tickets you are involved in, or when there are new alerts or requests for resources you are following or administering.
- Email Subject
- {tenant.name} Notification: Welcome
- Email Body
<p>Welcome to {tenant.name}.</p> <p>Click the link below to login.</p> <p><a href="{tenant.theme.console.address}">{tenant.theme.console.address}</a></p> <p>Thanks,<br/> The {tenant.name} Team</p> {system.email.footer.html}
Welcome: to new user invited to be an Administrator, when a new tenant is created
Values
- Notification Type
- com.soa.notification.type.welcome.newtenant.admininvite
- Trigger
- New tenant is created, and the creator list one or more users to be invited to be an Administrator for the new tenant.
- Recipients (1+)
- Owners of one or more email addresses specified in the install script
- Notification Category
- None.
- Dashboard Subject
- Welcome to {tenant.name}
- Dashboard Content
- You are invited to be an Administrator for a new API Platform
- Email Subject
- {tenant.name} Notification: Invitation to be an API Platform Administrator
- Email Body
<p>A new API Platform was successfully created, and you are invited to be an Administrator for the site. Click the link below to log in:</p> <p><a href="{tenant.theme.console.address}">{tenant.theme.console.address}</a></p> <p>Some of the things you can do to get started:<br/> - Add APIs<br/> - Add apps<br/> - Connect apps to APIs<br/> - Test APIs<br/> - View API doc<br/> - Invite developers<br/> <p>If you have questions, refer to <a href="{tenant.theme.console.address}#/home/learnmore">the Community Manager developer portal help</a>.</p> <p>Thanks,<br/> The API Platform Team</p> {system.email.footer.html}
Password Reset
Values
- Notification Type
- com.soa.notification.type.password.reset
- Trigger
- User selects “forgot password” link
- Recipients (1)
- User who reset the password
- Notification Category
- None.
- Dashboard Subject
- None; email only
- Dashboard Content
- None; email only
- Email Subject
- {tenant.name} Notification: Password reset requested
- Email Body
<p>A request has been made to reset the password for your account {user.username}.</p> <p>Click the link below to reset your password.</p> <p><a href="{tenant.theme.console.address}#/home/forgotpassword/reset?resetCode={password.resetcode}">{tenant.theme.console.address}#/home/forgotpassword/reset?resetCode={password.resetcode}</a></p> <p>Alternatively, copy and paste the following reset code into the <a href="{tenant.theme.console.address}#/home/forgotpassword/reset">password reset form</a>: {password.resetcode}</p> <p>You will then be prompted to enter a new password.</p> <p>For security reasons, the reset code is only valid for a limited time.</p> <p><strong>Note:</strong> If you didn't request a password reset, you can ignore this email.</p> <p>Thanks,<br/> The {tenant.name} Team</p> {system.email.footer.html}
Example
From: acmepaymentscorp API Platform <platform@acmepaymentscorp.com> Sent: Thursday, February 20, 2020 11:11 AM To: jmead@acmepaymentscorp.com Subject: acmepaymentscorp Notification: Password reset requested A request has been made to reset the password for your account JenMead. Click the link below to reset your password. https://acmepaymentscorp.apiportal.com/home/forgotpassword/reset?email=jmead@acmepaymentscorp.com&resetCode=wK-s5ERn5qm79Wt56QPyDQb4z9AzkeQmqniITenY7DyWbzLs6kS2NkTqg0uejaCH5gTZmD7SBa2oIFlkyOrj15RXUk0jnpB4mBUnRRz_qeAlzUrpx3_scgeAJ6nttMovKybgsAr7--23WAx68 Alternatively, copy and paste the following reset code into the password reset form: wK-s5ERn5qm79Wt56QPyDQb4z9AzkeQmqniITenY7DyWbzLs6kS2NkTqg0uejaCH5gTZmD7SBa2oIFlkyOrj15RXUk0jnpB4mBUnRRz_qeAlzUrpx3_scgeAJ6nttMovKybgsAr7--23WAx68 You will then be prompted to enter a new password. For security reasons, the reset code is only valid for a limited time. Note: If you did not request a password reset, you can ignore this email. Thanks, The acmepaymentscorp Team Please do not reply directly to this email.
Password Reset (User never logged in)
Values
- Notification Type
- com.soa.notification.type.password.reset.user.neverloggedin
- Trigger
- User is logging in for the first time and selects “forgot password” link
- Recipients (1)
- User who is logging in for the first time and attempts to reset the password.
- Notification Category
- None.
- Dashboard Subject
- None; email only
- Dashboard Content
- None; email only
- Email Subject
- {tenant.name} Notification: Password reset requested
- Email Body
<p>A request has been made to reset the password for your account. However, the password can only be reset after the first successful login.</p> <p>If you cannot log in for the first time, please contact a Site Administrator for assistance.</p> <p>Once you've completed the first login, you can change your password by clicking the Profile link at the top of the page, or you can click Forgot Password on a subsequent login to reset the password.</p> <p>Thanks,<br /> The {tenant.name} Team</p> {system.email.footer.html}
Invitation to Sign Up: Password Reset Request: User Never Signed In
Values
- Notification Type
- com.soa.notification.type.password.reset.user.signup.incomplete
- Trigger
- User account is in pending_validation, invited, or signup_inprocess state; user has never successfully signed in, but user clicks “forgot password” -- AND allowUserEnum is disabled.
- Recipients (1)
- User who has never successfully signed in and requests password reset
- Notification Category
- None.
- Dashboard Subject
- None; email only
- Dashboard Content
- None; email only
- Email Subject
- {tenant.name} Notification: Password reset requested
- Email Body
<p>Hello,</p> <p>A request has been made to reset the password for an account on {tenant.theme.console.address} with your email address, but the account is not yet confirmed. You cannot reset the password until you have completed the signup process.</p> <p>Please try the signup process again. If you received a confirmation or invitation email, please click the link in the email to complete the process. Once you've signed in, you'll be able to change your password.</p> <p>If you need help, feel free to contact us at {tenant.contact.email}.</p> <p>Thanks,<br/> The {tenant.name} Team</p> {system.email.footer.html}
Invitation to Sign Up: Password Reset Request: User Account Disabled
Values
- Notification Type
- com.soa.notification.type.password.reset.user.account.disabled
- Trigger
- User account is in com.soa.user.status.disabled state; user has never successfully signed in, but user clicks “forgot password” -- AND allowUserEnum is disabled.
- Recipients (1)
- User whose account is disabled and user requests password reset
- Notification Category
- None.
- Dashboard Subject
- None; email only
- Dashboard Content
- None; email only
- Email Subject
- {tenant.name} Notification: Password reset requested
- Email Body
<p>Hello,</p> <p>A request has been made to reset the password for an account on {tenant.theme.console.address} with your email address, but the account is currently disabled. You cannot reset the password on a disabled account.</p> <p>If you need further assistance, please contact a Site Administrator.</p> <p>Thanks,<br/> The {tenant.name} Team</p> {system.email.footer.html}
Invitation to Sign Up: Password Reset Request by Unregistered User
Values
- Notification Type
- com.soa.notification.type.password.reset.acct.not.exist
- Trigger
- User requests password reset and gives email address that is not a registered user account.
- Recipients (1)
- Unregistered user who requests password reset
- Notification Category
- None.
- Dashboard Subject
- None; email only
- Dashboard Content
- None; email only
- Email Subject
- {tenant.name} Notification: Password reset requested
- Email Body
<p>Hello,</p> <p>A request has been made to reset the password for an account on {tenant.theme.console.address} with your email address, but the account does not yet exist.</p> <p>To create an account, you can sign up at {tenant.name}. Just click the link below. You can also copy and paste the link into your browser.</p> <p><a href="{tenant.theme.console.address}#/home/signup">{tenant.theme.console.address}#/home/signup</a></p> <p>If you need help, feel free to contact us at {tenant.contact.email}.</p> <p>Thanks,<br/> The {tenant.name} Team</p> {system.email.footer.html}
Invitation to Sign Up: Password Reset Request by Non-Local User
Values
- Notification Type
- com.soa.notification.type.password.reset.nonlocal.user
- Trigger
- User tries to reset password but user is not a local user
- Recipients (1)
- User who is trying to reset password, but is not a local user
- Notification Category
- None.
- Dashboard Subject
- None; email only
- Dashboard Content
- None; email only
- Email Subject
- {tenant.name} Notification: Password reset requested
- Email Body
<p>Hello,</p> <p>A request has been made to reset the password for an account on {tenant.theme.console.address} with your email address. However, this account was created by logging in with an external identity provider, such as Facebook, so we cannot reset the password.</p> <p>To log in with your existing account, go to {tenant.theme.console.address} and sign in by using this email address and authenticating via the same third-party provider.</p> <p>To create a new account, you can sign up at {tenant.name} with a different email address. Just click the link below. You can also copy and paste the link into your browser.</p> <p><a href="{tenant.theme.console.address}#/home/signup">{tenant.theme.console.address}#/home/signup</a></p> <p>If you need help, feel free to contact us at {tenant.contact.email}.</p> <p>Thanks,<br/> The {tenant.name} Team</p> {system.email.footer.html}
Signup Attempt: Account Already Exists (Local Account)
Values
- Notification Type
- com.soa.notification.type.signup.account.exist.localuser
- Trigger
- User tries to sign up at signup page with an email address for which a local account already exists.
- Recipients (1)
- Registered user who attempts to sign up again with the same email address
- Notification Category
- None.
- Dashboard Subject
- None; email only
- Dashboard Content
- None; email only
- Email Subject
- {tenant.name} Notification: Signup Attempt
- Email Body
<p>Hello,</p> <p>A request has been made to create an account on {tenant.theme.console.address} with this email address, but the account already exists.</p> <p>If you made this request, you can sign in at {tenant.theme.console.address} using this email address. If you''ve forgotten your password, click the Forgot Password link.</p> <p>If you did not make this request, we strongly recommend you take steps to make sure your email account is secure.</p> <p>If you need help, feel free to contact us at {tenant.contact.email}.</p> <p>Thanks,<br/> The {tenant.name} Team</p> {system.email.footer.html}
Contact Support
Values
- Notification Type
- com.soa.notification.type.contact.support
- Trigger
- User submits question for support
- Recipients (1)
- System administrators
- Notification Category
- None.
- Dashboard Subject
- None; email only
- Dashboard Content
- None; email only
- Email Subject
- Support request from {tenant.name} portal user
- Email Body
<p>{tenant.name} user requested support on the portal with the following details.<br/> <b>Name:</b> {author.name}<br/> <b>Email:</b> {author.email}<br/> <b>Subject:</b> {support.subject}<br/> <b>Question:</b> {support.question}<br/></p> {system.email.footer.html}
Create Post (API)
Values
- Notification Type
- com.soa.notification.type.api.post.created
- Trigger
- User creates a post on an API
- Recipients (1)
- API administrators of the API. App team members and post creator are not notified
- Notification Category
- None.
- Dashboard Subject
- {api.name}: {post.title}
- Dashboard Content
- A post has been created by {author.username} for your API.
- Email Subject
- {tenant.name} Notification: {author.username} has submitted a post on your API
- Email Body
<p>{author.username} has submitted a post titled "{post.title}" for the {api.name} API. {author.username} wrote:</p> <p>"{post.text}"</p> <p>Login at {tenant.theme.console.address} to reply to this post.</p> <p>Thanks,<br/> The {tenant.name} Team</p> <p><em>Please do not reply directly to this email. If you do not want to receive these notifications, login to {tenant.theme.console.address} and update the notification settings in the Account Settings section.</em></p> {system.email.footer.html}
Invitation to Sign Up
Values
- Notification Type
- com.soa.notification.type.invite
- Trigger
- One user invites another to sign up.
- Recipients (1)
- The invited user.
- Notification Category
- None.
- Dashboard Subject
- None; email only
- Dashboard Content
- None; email only
- Email Subject
- Invitation to join {tenant.name}
- Email Body
<p>You have been invited to join {tenant.name} by {user.firstname} {user.lastname}. The invitation reads:</p> <p>"{invitation.text}"</p> <p>To explore, please click the link below. You can also just copy and paste the link into your browser.</p> <p><a href="{tenant.theme.console.address}#/home/signup/{invitation.code}">{tenant.theme.console.address}#/home/signup/{invitation.code}</a></p> <p>If you need help, feel free to contact us at {tenant.contact.email}.</p> <p>Thanks,<br/> The {tenant.name} Team</p> {system.email.footer.html}
Invitation to Sign Up When User Already Exists
Values
- Notification Type
- com.soa.notification.type.invite.alreadyactive
- Trigger
- User invitation issued from the Invite User link in the Community Manager developer portal menu; user already exists
- Recipients (1)
- Invited user only
- Notification Category
- None.
- Dashboard Subject
- None; email only
- Dashboard Content
- None; email only
- Email Subject
- New invitation to join {tenant.name}
- Email Body
<p>Hello,</p> <p>{user.firstname} {user.lastname} just invited you to join {tenant.name}, with the following message:</p> <p>"{invitation.text}"</p> <p>We noticed that you already have an account, but want to let you know that this happened.</p> <p>If you need help, feel free to contact us at {tenant.contact.email}.</p> <p>Thanks,<br/> The {tenant.name} Team</p> {system.email.footer.html}
Signup Attempt When User Already Exists
Values
- Notification Type
- com.soa.notification.type.alreadyactive
- Trigger
- User tries to sign up when user has already signed up.
- Recipients (1)
- User who is trying to sign up.
- Notification Category
- None.
- Dashboard Subject
- None; email only
- Dashboard Content
- None; email only
- Email Subject
- Signup Confirmation
- Email Body
<p>Welcome to {tenant.name}, {user.firstname}!</p> <p>You requested an activation email, but have already completed the signup and activation process. If you have forgotten your password, please click the link below:</p> <p><a href="{tenant.theme.console.address}#/home/forgotpassword">{tenant.theme.console.address}#/home/forgotpassword</a></p> <p>If you did not request this activation email, you may safely ignore it.</p> <p>If clicking on the above link does not work, please copy and paste the entire URL into your browser.</p> <p>If you need help, feel free to contact us at <a href="mailto:{tenant.contact.email}">{tenant.contact.email}</a>.</p> <p>Happy Coding,<br /> The {tenant.name} Team</p> {system.email.footer.html}
User Deleted by Site Admin: To User: Signup State = Registered
Values
- Notification Type
- com.soa.notification.type.userdeleted.registered
- Trigger
- Site Admin removes a user who is in Registered state.
- Recipients (1)
- Deleted user
- Notification Category
- None.
- Dashboard Subject
- None; email only
- Dashboard Content
- None; email only
- Email Subject
- Your user account on {tenant.name} has been deleted
- Email Body
<p>Hello,</p> <p>Your user account on {tenant.name} has been deleted by a Site Administrator.</p> <p>If you have questions or need help, feel free to contact us at <a href="mailto:{tenant.contact.email}">{tenant.contact.email}</a>.</p> <p><strong>Note:</strong> If you created content, such as tickets, discussions, and comments, your content was not deleted because it might be helpful to other users.</p> <p>Thanks,<br /> The {tenant.name} Team</p> {system.email.footer.html}
User Deleted by Site Admin: To User: Signup State = pending_validation
Values
- Notification Type
- com.soa.notification.type.userdeleted.pending_validation
- Trigger
- Site Admin removes a user who is in pending_validation state.
- Recipients (1)
- Deleted user
- Notification Category
- None.
- Dashboard Subject
- None; email only
- Dashboard Content
- None; email only
- Email Subject
- Your pending user account on {tenant.name} has been deleted
- Email Body
<p>Hello,</p> <p>Your user account (pending confirmation) on {tenant.name} has been deleted by a Site Administrator.</p> <p><strong> Note:</strong> Pending status means that you started the signup process but didn't confirm registration.</p> <p>The link in the registration email that was sent to you previously is no longer valid. If you want to sign up on the platform, just start the signup process again at <a href="{tenant.theme.console.address}">{tenant.theme.console.address}</a>.</p> <p>If you have questions or need help, feel free to contact us at <a href="mailto:{tenant.contact.email}">{tenant.contact.email}</a>.</p> <p>Thanks,<br /> The {tenant.name} Team</p> {system.email.footer.html}
User Deleted by Site Admin: To User: Signup State = inviteduser
Values
- Notification Type
- com.soa.notification.type.userdeleted.inviteduser
- Trigger
- Site Admin removes a user who is in inviteduser state.
- Recipients (1)
- Deleted user
- Notification Category
- None.
- Dashboard Subject
- None; email only
- Dashboard Content
- None; email only
- Email Subject
- Your user account on {tenant.name} has been deleted
- Email Body
<p>Hello,</p> <p>Your user account (as an invited user) on {tenant.name} has been deleted by a Site Administrator.</p> A reserved account is when someone is invited and you have not yet registered. <p><strong> Note:</strong> Invited status means that another user issued an invitation to you but you didn't yet sign up.</p> <p>The link in the invitation email that was sent to you previously is no longer valid. If you want to sign up on the platform, just follow the signup process at <a href="{tenant.theme.console.address}">{tenant.theme.console.address}</a>.</p> <p>If you have questions or need help, feel free to contact us at <a href="mailto:{tenant.contact.email}">{tenant.contact.email}</a>.</p> <p>Thanks,<br /> The {tenant.name} Team</p> {system.email.footer.html}
User Added by Site Admin: To User
Values
- Notification Type
- com.soa.notification.type.user.admin.added
- Trigger
- Site Admin adds a user.
- Recipients (1)
- User added by Site Admin.
- Notification Category
- None.
- Dashboard Subject
- None; email only
- Dashboard Content
- None; email only
- Email Subject
- A user account on {tenant.name} has been created for you
- Email Body
<p>Hello,</p> <p>A user account on {tenant.name} has been created for you by a Site Administrator.</p> <p>To complete account registration and setup, log in using this email address at the platform URL: <a href="{tenant.theme.console.address}">{tenant.theme.console.address}</a>. You will need your temporary password. If you don't yet have it, contact your Site Administrator.</p> <p>You might also need to complete other steps such as accepting the platform terms and conditions.</p> <p>After you complete the login process using the default password, remember to choose a new password.</p> <p>Thanks,<br /> The {tenant.name} Team</p> {system.email.footer.html}
Example
From: acmepaymentscorp API Platform <platform@acmepaymentscorp.com> Sent: Monday, January 13, 2020 8:51 PM To: jswift@acmepaymentscorp.com Subject: A user account on acmepaymentscorp has been created for you Hello, A user account on acmepaymentscorp has been created for you by a Site Administrator. To complete account registration and setup, log in using this email address at the platform URL: https://acmepaymentscorp.apiportal.com/home/login/j24bm_vQDdxEWNK5rwYeUYq-vaA4mSNpSvKk4JO3Iw5GNK3L6fXxn-l4kBpNZEIXjpfMpkNhOFQmws5mvo1jAcwCy-r_sNZOqMWT9bciyCEQ3sZ12v5-M5EqVMxcVFPwcB_sFs. You will need your temporary password. If you don't yet have it, contact your Site Administrator. You might also need to complete other steps such as accepting the platform terms and conditions. After you complete the login process using the default password, remember to choose a new password. Thanks, The acmepaymentscorp Team
User Added by Site Admin: First Login: to Site Admin
Values
- Notification Type
- com.soa.notification.type.user.logged.in.first.time
- Trigger
- User who was added by a Site Admin logs in for the first time.
- Recipients (1+)
- Site Admins
- Notification Category
- None.
- Dashboard Subject
- New user login: {user.name}
- Dashboard Content
- A user added by a Site Admin logged in for the first time.
- Email Subject
- User {user.name}, added by Site Admin, logged in for the first time
- Email Body
<p>Hello,</p> <p>A user that a Site Admin added on {tenant.name} has logged in for the first time.</p> <p>User: {user.name}</p> <p>Thanks,<br /> The {tenant.name} Team</p> {system.email.footer.html}
Example
From: acmepaymentscorp API Platform <platform@acmepaymentscorp.com> Sent: Monday, January 27, 2020 9:45 PM To: jswift@acmepaymentscorp.com Subject: User JenMeadows, added by Site Admin, logged in for the first time Hello, A user that a Site Admin added on acmepaymentscorp has logged in for the first time. User: JenMeadows Thanks, The acmepaymentscorp Team
User Account Status Change: User Enabled
Values
- Notification Type
- com.soa.notification.type.user.enabled
- Trigger
- A user account changes status to an Enabled status.
- Recipients (1)
- User
- Notification Category
- None.
- Dashboard Subject
- User account activated
- Dashboard Content
- Your user account has been activated by a Site Admin
- Email Subject
- {tenant.name} Notification: User account activated
- Email Body
<p>Hello,</p> <p>Your user account on {tenant.name} has been activated by a Site Administrator.</p> <p>If you have questions or need help, feel free to contact us at <a href="mailto:{tenant.contact.email}">{tenant.contact.email}</a>.</p> <p>Thanks,<br /> The {tenant.name} Team</p> {system.email.footer.html}
User Account Status Change: User Disabled
Values
- Notification Type
- com.soa.notification.type.user.disabled
- Trigger
- A user account changes status to a Disabled status.
- Recipients (1)
- User
- Notification Category
- None.
- Dashboard Subject
- User account disabled
- Dashboard Content
- Your user account has been disabled by a Site Admin
- Email Subject
- {tenant.name} Notification: User account disabled
- Email Body
<p>Hello,</p> <p>Your user account on {tenant.name} has been disabled by a Site Administrator.</p> <p>If you have questions or need help, feel free to contact us at <a href="mailto:{tenant.contact.email}">{tenant.contact.email}</a>.</p> <p>Thanks,<br /> The {tenant.name} Team</p> {system.email.footer.html}
User Account Status Change: User Locked
Values
- Notification Type
- com.soa.notification.type.user.locked
- Trigger
- A user account changes status to a Locked status.
- Recipients (1)
- User
- Notification Category
- None.
- Dashboard Subject
- User account locked
- Dashboard Content
- Your user account has been locked by a Site Admin
- Email Subject
- {tenant.name} Notification: User account locked
- Email Body
<p>Hello,</p> <p>Your user account on {tenant.name} has been locked by a Site Administrator.</p> <p>If you have questions or need help, feel free to contact us at <a href="mailto:{tenant.contact.email}">{tenant.contact.email}</a>.</p> <p>Thanks,<br /> The {tenant.name} Team</p> {system.email.footer.html}
User Account Status Change: User Unlocked
Values
- Notification Type
- com.soa.notification.type.user.unlocked
- Trigger
- A user account changes status to an Unlocked status.
- Recipients (1)
- User
- Notification Category
- None.
- Dashboard Subject
- User account unlocked
- Dashboard Content
- Your user account has been unlocked by a Site Admin
- Email Subject
- {tenant.name} Notification: User account unlocked
- Email Body
<p>Hello,</p> <p>Your user account on {tenant.name} has been unlocked by a Site Administrator.</p> <p>If you have questions or need help, feel free to contact us at <a href="mailto:{tenant.contact.email}">{tenant.contact.email}</a>.</p> <p>Thanks,<br /> The {tenant.name} Team</p> {system.email.footer.html}
User Account Status Change (for Admins)
Values
- Notification Type
- com.soa.notification.type.user.account.status.change
- Trigger
- A user account changes status.
- Recipients (1+)
- Site Admin, Business Admin (users get separate notification for each status change)
- Notification Category
- None.
- Dashboard Subject
- User account {user.name} new status: {user.status}
- Dashboard Content
- A user account was changed by {author.username}
- Email Subject
- {tenant.name} Notification: User account status change
- Email Body
<p>Hello,</p> <p>A user account on {tenant.theme.console.address} has changed status.</p> <p>User: {user.name}</p> <p>New status: {user.status}</p> <p>This change was made by: {author.username}</p> <p>Thanks,<br/> The {tenant.name} Team</p> {system.email.footer.html}
Email Notification with 2FA authentication code
Values
- Notification Type
- com.soa.notification.type.user.2fa.verification.code
- Trigger
- User signing up or logging in where 2FA is turned on.
- Recipients (1)
- User only
- Notification Category
- None.
- Dashboard Subject
- None; email only
- Dashboard Content
- None; email only
- Email Subject
- {tenant.name} Notification: Your login verification code
- Email Body
<p>Hello,</p> <p>Your one-time verification code for online access is {2fa.verification.code}. The code is valid for {5} minutes.</p> <p>If you have questions or need help, feel free to contact us at <a href="mailto:{tenant.contact.email}">{tenant.contact.email}</a>. Please do not reply to this message.</p> <p>Thanks,<br /> The {tenant.name} Team</p> {system.email.footer.html}
User added by Site Admin: Notification to user on account activation
Valid in Version: 2019.1.6 and later
Values
- Notification Type
- com.soa.notification.type.user.activated
- Trigger
- A Site Admin activates a user account that was added by the Site Admin.
- Recipients (1)
- User only
- Notification Category
- None.
- Default/Customized?
- Used only when functionality commented out in the default user workflow template is implemented. For instructions, see @UserActivated (user workflow doc).
- Dashboard Subject
- User account activated
- Dashboard Content
- Your user account has been activated by a Site Admin
- Email Subject
- {tenant.name} Notification: User account activated
- Email Body
<p>Hello,</p> <p>Your user account on {tenant.name} has been activated by a Site Administrator.</p> <p>If you have questions or need help, feel free to contact us at <a href="mailto:{tenant.contact.email}">{tenant.contact.email}</a>.</p> <p>Thanks,<br /> The {tenant.name} Team</p> {system.email.footer.html}
Example
From: acmepaymentscorp API Platform <platform@acmepaymentscorp.com> Sent: Monday, January 28, 2020 8:00 AM To: user1@acmepaymentscorp.com Subject: Notification: User account activated Hello, Your user account on acmepaymentscorp has been activated by a Site Administrator. If you have questions or need help, feel free to contact us at info@acmepaymentscorp.com. Thanks, The acmepaymentscorp Team
Email address has been changed (third-party email address change)
Valid in Version: 2020.1.0 and later
Values
- Notification Type
- com.soa.notification.type.external.email.changed
- Trigger
- A user changes the email address in the user profile for an account that is using a third-party domain, such as Google, for login.
- Recipients (1)
- User
- Notification Category
- None.
- Dashboard Subject
- None; email only
- Dashboard Content
- None; email only
- Email Subject
- {tenant.name} Notification: Email address has been changed
- Email Body
<p>This is a courtesy notification to let you know that the email address for your account {user.username} on <a href="{tenant.theme.console.address}">{tenant.theme.console.address}</a> has been changed, from {email.oldEmail} to {email.newEmail}.</p> <p>You will no longer receive notifications at {email.oldEmail}. All account activity will use the new email address.</p> <p><strong>Note:</strong> If you did not make this change, please contact a Site Administrator or the Security Team.</p> <p><em>Please do not reply directly to this email.</em></p> <p>Thanks,<br/> The {tenant.name} Team</p>
Example
From: acmepaymentscorp API Platform <platform@acmepaymentscorp.com> Sent: Wednesday, June 24, 2020 12:00 AM To: user1@acmepaymentscorp.com Subject: acmepaymentscorp Notification: Email address has been changed Hello, This is a courtesy notification to let you know that the email address for your account User1 on http://acmepaymentscorp.com/acmecorp/ has been changed, from user1@acmepaymentscorp.com to user2@acmepaymentscorp.com. You will no longer receive notifications at user1@acmepaymentscorp.com. All account activity will use the new email address. Note: If you did not make this change, please contact a Site Administrator or the Security Team. Thanks, The acmepaymentscorp Team
Email address has been changed by a site administrator (third-party email address change)
Valid in Version: 2020.1.0 and later
Values
- Notification Type
- com.soa.notification.type.siteadmin.external.email.changed
- Trigger
- A Site Admin changes the email address for an account that is using a third-party domain, such as Google, for login.
- Recipients (1)
- User
- Notification Category
- None.
- Dashboard Subject
- None; email only
- Dashboard Content
- None; email only
- Email Subject
- {tenant.name} Notification: Email address has been changed by a site administrator
- Email Body
<p>This is a courtesy notification to let you know that a site administrator has changed the email address for your account {user.username} on <a href=“{tenant.theme.console.address}“>{tenant.theme.console.address}</a>, from {email.oldEmail} to {email.newEmail}.</p> <p>You will no longer receive notifications at {email.oldEmail}. All account activity will use the new email address.</p> <p><strong>Note:</strong> If you have questions about this change, please contact a Site Administrator or the Security Team.</p> <p><em>Please do not reply directly to this email.</em></p> <p>Thanks,<br/> The {tenant.name} Team</p> {system.email.footer.html}'