Community Manager Notifications: API Admin/API Group

Information about email and Dashboard notifications in the Community Manager developer portal, for API admins and API groups.

Table of Contents

API Admin Notifications:

API Group Notifications:

API Admin Notifications

API Admin Invited (to Invited Person)

Values

Notification Type
com.soa.notification.type.apiadmin.member.invited.invitee
Trigger
An API admin invites someone else to be an API admin for the same API
Recipients (1)
Only the person invited (existing API Admins for the same API receive a different notification).
Notification Category
None.
Dashboard Subject
{api.name}
Dashboard Content
{author.username} has invited you to be an API Administrator
Email Subject
You've been invited to be an API Administrator for {api.name}
Email Body
<p>Hello from {tenant.name},</p>
<p>{invitingmember.username} has invited you to be an API Administrator for the {api.name} on {tenant.name}.</p>
<p>Here's the message {invitingmember.username} wrote to you:</p>
<p>"{invitation.text}"</p>
<p>If you already have a {tenant.name} account, click here {tenant.theme.console.address} to accept or reject your invitation. If you're not a member yet, please sign up at {tenant.theme.console.address}#/home/signup/{invitation.code} using your {invitedmember.email} email address.</p>
<p>Thanks,<br />
The {tenant.name} Team</p>
{system.email.footer.html}

Example

From: acmepaymentscorp API Platform <platform@acmepaymentscorp.com>
Sent: Wednesday, April 3, 2019 5:42 PM
To: jmead@acmepaymentscorp.com
Subject: You've been invited to be an API Administrator for FAA_Airport_Status
Hello from acmepaymentscorp,
JaneSaoirse has invited you to be an API Administrator for the FAA_Airport_Status on acmepaymentscorp.
Here's the message JaneSaoirse wrote to you:
"Invite to be an API Admin for FAA_Airport_Status API."
If you already have a acmepaymentscorp account, click here https://acmepaymentscorp.apiportal.com/ to accept or reject your invitation. If you're not a member yet, please sign up at https://acmepaymentscorp.apiportal.com/home/signup/nJYBqrroOfn6-yiiIubrF83_CBuSPJUyF4oEZqhGctIQ_xpRnGA1kk1hk0KHOAQZsmQNIg0XU39DB3DBTkHyF2cBytV9fHuf8NLbLQNzlsVwEvxCQUVdhNN4qCQ using your jmead@acmepaymentscorp.com email address.
Thanks,
The acmepaymentscorp Team

API Admin Invited (to Existing API Admins)

Values

Notification Type
com.soa.notification.type.apiadmin.member.invited.team
Trigger
An API admin invites someone else to be an API admin for the same API
Recipients (1+)
Existing API Admins for the same API (invited person receives a different notification)
Notification Category
None.
Dashboard Subject
{api.name}
Dashboard Content
{invitedmember.name} has been invited to be an API Administrator
Email Subject
{invitedmember.name} has been invited to be an API Administrator for {api.name}
Email Body
<p>Hi {api.name} Administrator,</p>
<p>A new member has been invited to accept an Administrator role for the {api.name}. Please refer to the details below:</p>Member extending the invitation: {author.username}<br />
New member invited: {invitedmember.name}</p>
<p>Thanks,<br />
The {tenant.name} Team</p>
{system.email.footer.html}

Example

From: acmepaymentscorp API Platform <platform@acmepaymentscorp.com>
Sent: Wednesday, April 3, 2019 5:44 PM
To: jswift@acmepaymentscorp.com
Subject: JonathanSwift has been invited to be an API Administrator for FAA_Airport_Status
Hi FAA_Airport_Status Administrator,
A new member has been invited to accept an Administrator role for the FAA_Airport_Status. Please refer to the details below:
Member extending the invitation: JenMead
New member invited: JonathanSwift
Thanks,
The acmepaymentscorp Team

API Admin: Invitation Resent (to Invited API Admin)

Values

Notification Type
com.soa.notification.type.apiadmin.member.inviteresent.invitee
Trigger
An API admin resends an invitation to be an API admin for the same API
Recipients (1)
Only the person invited. Could be a platform member or non-member.
Notification Category
None.
Dashboard Subject
{api.name}
Dashboard Content
{author.username} has resent your invitation to be an API Administrator
Email Subject
Reminder: You've been invited to be an API Administrator for {api.name}
Email Body
<p>Hello from {tenant.name},</p>
<p>This is a reminder that {invitingmember.username} has invited you to be an API Administrator for the {api.name} on {tenant.name}. Please follow the instructions below to accept or reject the invitation.</p>
<p>Here's the message {invitingmember.username} wrote to you:</p>
<p>"{invitation.text}"</p>
<p>If you already have a {tenant.name} account, click here {tenant.theme.console.address} to accept or reject your invitation. If you're not a member yet, please sign up at {tenant.theme.console.address}#/home/signup/{invitation.code} using your {invitedmember.email} email address.</p>
<p>Thanks,<br />
The {tenant.name} Team</p>
{system.email.footer.html}

API Admin Invitation Accepted

Values

Notification Type
com.soa.notification.type.apiadmin.membership.accepted
Trigger
User accepts an invitation to be an API admin.
Recipients (1+)
All admins for the API (including the invited user who is now an API admin)
Notification Category
None.
Dashboard Subject
{api.name}
Dashboard Content
{invitedmember.username} has accepted an invitation to be an API Administrator
Email Subject
{invitedmember.username} has accepted an invitation to be an API Administrator
Email Body
<p>Hi {api.name} Administrator,</p>
<p>{invitedmember.username} has accepted an invitation to be an Administrator for the {api.name}.</p>
<p>Here''s what {invitedmember.username} had to say:</p>
<p>"{comment.text}"</p>
<p>Thanks,<br />
The {tenant.name} Team</p>
{system.email.footer.html}

API Admin Invitation Rejected

Values

Notification Type
com.soa.notification.type.apiadmin.membership.rejected
Trigger
User rejects an invitation to be an API admin.
Recipients (1+)
All admins for the API (not including the user who rejected)
Notification Category
None.
Dashboard Subject
{api.name}
Dashboard Content
{invitedmember.username} has rejected an invitation to be an API Administrator
Email Subject
{invitedmember.username} has rejected an invitation to be an API Administrator
Email Body
<p>Hi {api.name} Administrator,</p>
<p>{invitedmember.username} has rejected an invitation to be an Administrator for the {api.name}.</p>
<p>Here's what {invitedmember.username} had to say:</p>
<p>"{comment.text}"</p>
<p>Thanks,<br />
The {tenant.name} Team</p>
{system.email.footer.html}

API Admin Removed (to Remaining API Admins)

Values

Notification Type
com.soa.notification.type.apiadmin.member.removed.to.individual
Trigger
API Admin is removed.
Recipients (1)
Removed API admin
Notification Category
None.
Dashboard Subject
{api.name}
Dashboard Content
You are no longer an Administrator for this API
Email Subject
You are no longer an Administrator for {api.name}
Email Body
<p>Hi {tenant.name} Member,</p>
<p>You've been removed from the Administrator role for the {api.name}, by {author.username}.</p>
<p>Here's the message {author.username} wrote:</p>
<p>"{comment.text}"</p>
<p>For further details, please visit your <a href="{tenant.theme.console.address}#/home/dashboard">Dashboard</a>.</p>
<p>Thanks,<br />
The {tenant.name} Team</p>
{system.email.footer.html}

API Admin Removed (to Remaining API Admins)

Values

Notification Type
com.soa.notification.type.apiadmin.member.removed.to.remaining.admins
Trigger
API Admin is removed.
Recipients (1+)
Remaining API admins (removed API admin gets a different notification).
Notification Category
None.
Dashboard Subject
{api.name}
Dashboard Content
{invitedmember.name} is no longer an Administrator for this API
Email Subject
{invitedmember.name} is no longer an Administrator for {api.name}
Email Body
<p>Hi {api.name} Administrator,</p>
<p>{invitedmember.name} has been removed from the Administrator role for the {api.name}, by {author.username}.</p>
<p>Here's the message {author.username} wrote:</p>
<p>"{comment.text}"</p>
<p>For further details, please visit your <a href="{tenant.theme.console.address}#/home/dashboard">Dashboard</a>.</p>
<p>Thanks,<br />
The {tenant.name} Team</p>
{system.email.footer.html}

API Access Cancelled, API Deleted

Values

Notification Type
com.soa.notification.type.api.access.cancelled.apideleted
Trigger
An API is deleted.
Recipients (1+)
API Administrators, Private API Group members, members of any groups associated with the API
Notification Category
None.
Dashboard Subject
{api.name}
Dashboard Content
An API has been deleted
Email Subject
An API ({api.name}) has been deleted
Email Body
<p>Hi,</p>
<p>An API that you were associated with has been deleted. All access has been cancelled and all Administrator or Group Leader or Member roles associated with the API are no longer effective. Details:</p>
API Name: {api.name} <br />
API Version: {api.version}<br />
Environment: {contract.environment}<br />
State Change: from {contract.oldstate} to {contract.state}.</p>
<p>This change was made by {author.username}</p>
<p>Thanks,<br />
The {tenant.name} Team</p>
{system.email.footer.html}

API Group Notifications

API Group: Group Member Invited, to Invited Member

Values

Notification Type
com.soa.notification.type.privateapi.member.invited.invitee
Trigger
API Group leader or API administrator invites someone to join an API Group
Recipients (1)
Only the person invited. Could be a platform member or non-member (Group members and API administrator receive a different notification).
Notification Category
None.
Dashboard Subject
{api.name}
Dashboard Content
{author.username} has invited you to join the API Group {group.name}
Email Subject
You've been invited to join an API group on {tenant.name}
Email Body
<p>Hello from {tenant.name},</p>
<p>{author.username} has invited you to join {group.name}, an API Group on {tenant.name}.</p>
<p>Here's the message {author.username} wrote to you:</p>
<p>"{invitation.text}"</p>
<p>If you already have a {tenant.name} account, click here {tenant.theme.console.address} to accept or reject your invitation. If you're not a member yet, please sign up at {tenant.theme.console.address}#/home/signup/{invitation.code} using your {invitedmember.email} email address.</p>
<p>Happy Coding,<br />
The {tenant.name} Team</p>
{system.email.footer.html}

API Group Member Invited (API) (to Group)

Values

Notification Type
com.soa.notification.type.privateapi.member.invited.group
Trigger
API Group leader or API administrator invites someone to join an API Group
Recipients (1+)
API Group members and API administrator (invitee receives a different notification)
Notification Category
NOTIFICATION_TYPE_GROUP_GROUP_CHANGE
Dashboard Subject
{api.name}
Dashboard Content
New member invited to the API Group {group.name}
Email Subject
{invitedmember.name} has been invited to join your API Group
Email Body
<p>Hi {tenant.name} Member,</p>
<p>A new member has been invited to join your API Group. Please refer to the details below:</p>
<p>API Name: {api.name}<br />
API Group: {group.name}<br />
Member extending the invitation: {author.username}<br />
New member invited: {invitedmember.name}</p>
<p>Happy Coding,<br />
The {tenant.name} Team</p>
{system.email.footer.html}

API Group: Invitation Resent, to Invited Member

Values

Notification Type
com.soa.notification.type.privateapi.member.inviteresent.invitee
Trigger
API Group leader or API administrator resends an invitation to join an API Group
Recipients (1)
Only the person invited. Could be a platform member or non-member.
Notification Category
None.
Dashboard Subject
{api.name}
Dashboard Content
{author.username} has resent your invitation to join the API Group {group.name}
Email Subject
Reminder: You've been invited to join an API group on {tenant.name}
Email Body
<p>Hello from {tenant.name},</p>
<p>This is a reminder that {author.username} has invited you to join {group.name}, an API Group on {tenant.name}. Please follow the instructions below to accept or reject the invitation.</p>
<p>Here's the message {author.username} wrote to you:</p>
<p>"{invitation.text}"</p>
<p>If you already have a {tenant.name} account, click here {tenant.theme.console.address} to accept or reject your invitation. If you're not a member yet, please sign up at {tenant.theme.console.address}#/home/signup/{invitation.code} using your {invitedmember.email} email address.</p>
<p>Happy Coding,<br />
The {tenant.name} Team</p>
{system.email.footer.html}

API Group Membership Invitation Accepted (API)

Values

Notification Type
com.soa.notification.type.privateapi.membership.accepted
Trigger
User accepts API group member invite.
Recipients (1+)
API group leaders and members (including the invited user), API administrators.
Notification Category
NOTIFICATION_TYPE_GROUP_GROUP_CHANGE
Dashboard Subject
{api.name}
Dashboard Content
API Group {group.name}: invitation accepted by {invitedmember.username}
Email Subject
{invitedmember.username} has joined your API Group
Email Body
<p>Hi {tenant.name} Member,</p>
<p>{invitedmember.username} has accepted an invitation to be a member of your API Group. Please refer to the details below:</p>
<p>API Name: {api.name}<br />
API Group: {group.name}</p>
<p>Here's what {invitedmember.username} had to say:</p>
<p>"{comment.text}"</p>
<p>Happy Coding,<br />
The {tenant.name} Team</p>
{system.email.footer.html}

API Group Membership Invitation Rejected (API Group)

Values

Notification Type
com.soa.notification.type.privateapi.membership.rejected
Trigger
User rejects API group member invite
Recipients (1+)
API group leaders and members (not including the invited user), API administrators.
Notification Category
NOTIFICATION_TYPE_GROUP_GROUP_CHANGE
Dashboard Subject
{api.name}
Dashboard Content
API Group {group.name}: invitation rejected by {invitedmember.username}
Email Subject
{invitedmember.username} rejected a group invitation
Email Body
<p>Hi {tenant.name} Member,</p>
<p>{invitedmember.username} has rejected an invitation to be a member of your API Group. Please refer to the details below:</p>
<p>API Name: {api.name}<br />
API Group: {group.name}</p>
<p>Here's what {invitedmember.username} had to say:</p>
<p>"{comment.text}"</p>
<p>Happy Coding,<br />
The {tenant.name} Team</p>
{system.email.footer.html}

API Group Member Removed (API) (to Removed Group Member)

Values

Notification Type
com.soa.notification.type.privateapi.member.removed.to.individual
Trigger
API Group member is removed
Recipients (1)
Removed API Group member
Notification Category
None.
Dashboard Subject
{api.name}
Dashboard Content
You've been removed from the API Group {group.name}
Email Subject
You've been removed from an API Group
Email Body
<p>Hi {tenant.name} Member,</p>
<p>You've been removed from the API Group {group.name} for the {api.name}, by {author.username}.</p>
<p>Here's the message {author.username} wrote:</p>
<p>"{comment.text}"</p>
<p>For further details, please visit your <a href="{tenant.theme.console.address}#/home/dashboard">Dashboard</a>.</p>
<p>For further information, please contact {author.username}.</p>
<p>Happy Coding,<br />
The {tenant.name} Team</p>
{system.email.footer.html}

API Group Member Removed (API) (to Remaining Group)

Values

Notification Type
com.soa.notification.type.privateapi.member.removed.to.remaining.group
Trigger
API Group member is removed.
Recipients (1+)
API group leaders and members (except the removed group member, who receives a different notification), API administrators
Notification Category
NOTIFICATION_TYPE_GROUP_GROUP_CHANGE
Dashboard Subject
{api.name}
Dashboard Content
API Group {group.name}: member removed
Email Subject
A group member has been removed from your API Group {group.name}
Email Body
<p>Hi {tenant.name} Member,</p>
<p>{invitedmember.name} has been removed from the API Group "{group.name}" for the {api.name}, by {author.username}.</p>
<p>Here's the message {author.username} wrote:</p>
<p>"{comment.text}"</p>
<p>For further details, please visit your <a href="{tenant.theme.console.address}#/home/dashboard">Dashboard</a>.</p>
<p>Happy Coding,<br />
The {tenant.name} Team</p>
{system.email.footer.html}

API Group Membership Role Changed (API)

Values

Notification Type
com.soa.notification.type.privateapi.membership.status.changed
Trigger
API group leader or API administrator makes a group member a group leader, or makes a leader a group member.
Recipients (1+)
API group leaders and members, API administrators.
Notification Category
NOTIFICATION_TYPE_GROUP_GROUP_CHANGE
Dashboard Subject
{api.name}
Dashboard Content
API Group {group.name}: Role change
Email Subject
An API Group {group.name} member has changed role
Email Body
<p>Hi {tenant.name} Member,</p>
<p>A member of your API Group {group.name} for {api.name} has changed role. Please refer to the details below:</p>
<p>Member: {invitedmember.name}<br />
Old role: {groupmembership.oldrole}<br />
New role: {groupmembership.role}</p>
<p>Note: An API Group can have more than one group leader.</p>
<p>This change was made by {author.username}.</p>
<p>Happy Coding,<br />
The {tenant.name} Team</p>
{system.email.footer.html}

API Group: Group Deleted

Values

Notification Type
com.soa.notification.type.privateapi.group.deleted
Trigger
API Group is deleted.
Recipients (1+)
API group leaders and members, API administrators.
Notification Category
None.
Dashboard Subject
{api.name}
Dashboard Content
The group has been deleted
Email Subject
API Group {group.name}: The group has been deleted
Email Body
<p>Hi {tenant.name} Member,</p>
<p>An API group you were a member of, {group.name}, has been deleted by {author.username}.</p>
<p>For further information, please contact {author.username}.</p>
<p>Happy Coding,<br />
The {tenant.name} Team</p>
{system.email.footer.html}