Community Manager Notifications: Reviews, Tickets, and Comments

Information about email and Dashboard notifications in the Community Manager developer portal, for reviews, tickets, and comments.

Review Notifications:

Ticket Notifications:

Comment Notifications:

Review Notifications

API Review Created

Values

Notification Type
com.soa.notification.type.api.review.created
Trigger
Someone writes a review for an API.
Recipients (1+)
API team
Notification Category
Review notifications
Dashboard Subject
{api.name}: {review.title}
Dashboard Content
A review has been created by {author.username} for your API.
Email Subject
{tenant.name} Notification: {author.username} has submitted a review on your API
Email Body
<p>{author.username} has submitted a review titled "{review.title}" for the {api.name} API. {author.username} wrote:</p>
<p>"{review.text}"</p>
<p>Login at {tenant.theme.console.address} to reply to this review.</p>
<p>Thanks,<br/>
 The {tenant.name} Team</p>
{system.email.footer.html}

App Review Created

Values

Notification Type
com.soa.notification.type.app.review.created
Trigger
Someone writes a review for an app.
Recipients (1+)
App team
Notification Category
Review notifications
Dashboard Subject
{app.name}: {review.title}
Dashboard Content
A review has been created by {author.username} for your application.
Email Subject
{tenant.name} Notification: {author.username} has submitted a review on your application
Email Body
<p>{author.username} has submitted a review titled "{review.title}" for the {app.name} application. {author.username} wrote:</p>
<p>"{review.text}"</p>
<p>Login at {tenant.theme.console.address} to reply to this review.</p>
<p>Thanks,<br/>
The {tenant.name} Team</p>
{system.email.footer.html}

Example

From: acmepaymentscorp API Platform <platform@acmepaymentscorp.com>
Sent: Thursday, February 21, 2019 5:54 PM
To: jswift@acmepaymentscorp.com
Subject: acmepaymentscorp Notification: JenniferMeadows has submitted a review on your application
JenniferMeadows has submitted a review titled "What a brilliant app! Love it!" for the Peile Gaeilge application. JenniferMeadows wrote:
"My kids use this app and it's really helped them."
Login at https://acmepaymentscorp.apiportal.com/ to reply to this review.
Thanks,
The acmepaymentscorp Team

Please do not reply directly to this email.

Review Comment

Values

Notification Type
com.soa.notification.type.my.review.comment
Trigger
Someone comments on a user's review.
Recipients (1)
The user who wrote the review.
Notification Category
Review notifications
Dashboard Subject
{review.title}
Dashboard Content
Your review has been commented on by {comment.author}
Email Subject
{tenant.name} Notification: {comment.author} has commented on your review
Email Body
<p>{comment.author} has commented on your review titled {review.title}. {comment.author} wrote:</p>
<p>"{comment.text}"</p>
<p>Login at {tenant.theme.console.address} to reply to this comment.<p>
<p>Thanks,<br>
The {tenant.name} Team</p>
{system.email.footer.html}

Ticket Notifications

Ticket Created (to API Administrator)

Values

Notification Type
com.soa.notification.type.api.ticket.created
Trigger
User creates a ticket on an API
Recipients (1+)
API administrators
Notification Category
None.
Dashboard Subject
{ticket.id}: {ticket.title}
Dashboard Content
A ticket has been submitted by {author.username} for your {api.name} API.
Email Subject
{tenant.name} Notification: {author.username} has submitted a ticket for your API
Email Body
<p>{author.username} has submitted a ticket {ticket.id} titled "{ticket.title}" for the {api.name} API with a priority of {ticket.priority}.</p>
<p>{author.username} wrote:</p>
<p>"{ticket.text}"</p>
<p>Login at {tenant.theme.console.address} to reply to this ticket.</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}

Ticket Created (to App Team members using the API)

Values

Notification Type
com.soa.notification.type.app.ticket.created
Trigger
User creates a ticket on an API.
Recipients (1+)
App team members if an app is associated with the ticket. Otherwise N/A.
Notification Category
None.
Dashboard Subject
{ticket.id}: {ticket.title}
Dashboard Content
A ticket has been submitted by {author.username} for your {app.name} application.
Email Subject
{tenant.name} Notification: {author.username} has submitted a ticket for your application
Email Body
<p>{author.username} has submitted a ticket {ticket.id} titled "{ticket.title}" for the {api.name} API with a priority of {ticket.priority} that references your {app.name} application.</p>
<p>{author.username} wrote:</p>
<p>"{ticket.text}"</p>
<p>Login at {tenant.theme.console.address} to view this ticket.</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}

Ticket Priority Changed

Values

Notification Type
com.soa.notification.type.ticket.priority.changed
Trigger
User changes the priority of a ticket
Recipients (1+)
API administrators, and either the submitter (if no app is associated with the ticket) or the app team members (if app is associated with the ticket)
Notification Category
None.
Dashboard Subject
{ticket.id}: {ticket.title}
Dashboard Content
The ticket's priority has changed to {ticket.priority}.
Email Subject
{tenant.name} Notification: {modifier.username} has changed the priority of ticket {ticket.id}
Email Body
<p>{modifier.username} has changed the priority of ticket {ticket.id} from {ticket.oldpriority} to {ticket.priority}. {modifier.username} wrote:</p>
<p>"{comment.text}"</p>
<p>Login at {tenant.theme.console.address} to reply to this ticket.</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}

Ticket State Changed

Values

Notification Type
com.soa.notification.type.ticket.state.changed
Trigger
User changes the status of an API ticket
Recipients (1+)
API administrators, and either the submitter (if no app is associated with the ticket) or the app team members (if app is associated with the ticket).
Notification Category
NOTIFICATION_TYPE_GROUP_TICKET_CHANGE
Dashboard Subject
{ticket.id}: {ticket.title}
Dashboard Content
The ticket is now {ticket.state}.
Email Subject
{tenant.name} Notification: {modifier.username} has changed the status of ticket {ticket.id}
Email Body
<p>{modifier.username} has changed the status of ticket {ticket.id} from {ticket.oldstate} to {ticket.state}. {modifier.username} wrote:</p>
<p>"{comment.text}"</p>
<p>Login at {tenant.theme.console.address} to reply to this ticket.</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}

Comment Notifications

Post Comment

Values

Notification Type
com.soa.notification.type.my.post.comment
Trigger
User comments on an API or app post
Recipients (1+)
User who created the post
Notification Category
None.
Dashboard Subject
{post.title}
Dashboard Content
Your post has been commented on by {author.username}
Email Subject
{tenant.name} Notification: {author.username} has commented on your post
Email Body
<p>{author.username} has commented on your post titled {post.title}. {author.username} wrote:</p>
<p>"{comment.text}"</p>
<p>Login at {tenant.theme.console.address} to reply to this comment.<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}

Example

From: acmepaymentscorp API Platform <platform@acmepaymentscorp.com>
Sent: Thursday, February 21, 2019 5:55 PM
To: jswift@acmepaymentscorp.com
Subject: acmepaymentscorp Notification: JenniferMeadows has commented on your post
JenniferMeadows has commented on your post titled API Access request. JenniferMeadows wrote:
"Great tip, thanks!"
Login at https://acmepaymentscorp.apiportal.com/ to reply to this comment.
Thanks,
The acmepaymentscorp Team
Please do not reply directly to this email. If you do not want to receive these notifications, login to https://acmepaymentscorp.apiportal.com/ and update the notification settings in the Account Settings section.