Community Manager Notifications: Contracts
Information about email and Dashboard notifications in the Community Manager developer portal, for app/API contracts.
Table of Contents
API Contract Notifications:
- API Contract Requested (Access Request), Both Environments, to API Admins
- API Contract Requested (Access Request), Sandbox Environment, to App Team Members
- API Contract Requested (Access Request), Production Environment, to App Team Members
- API Contract Created (Access Request), Sandbox Environment, to App Team Members
- API Access Activated by Auto-Connect, in Sandbox environment: to app team members
- API Access Activated by Auto-Connect: to App Team Members
- API Access Approved, Production Environment, to App Team Members
- API Access Activated, Production Environment, to App Team Members
Contract Change Notifications:
- API Access State Change, Both Environments, to API Admins
- API Access Cancelled (At Request), Both Environments, to API Admins
- API Access Cancelled (App Deleted), Both Environments, to API Admins
- API Access Cancelled (App Live), Sandbox Environment, to API Admins
- API Access Suspended, Both Environments, to App Team Members
- API Access Resumed, Both Environments, to App Team Members
- API Access Resubmitted, Both Environments, to App Team Members
- API Access Rejected, Production Environment, to App Team Members
- API Access Cancelled (At Request), Both Environments, to App Team Members
- API Access Cancelled, API Deleted (to app team)
- API Deleted (to API Admin and Business Admin)
- API Version Deleted (to API Admin and Business Admin)
API Contract Notifications
API Contract Requested (Access Request), Both Environments, to API Admins
Values
- Notification Type
- com.soa.notification.type.api.access.requested.both.apiadmin
- Trigger
- App team member requests API access (either environment)
- Recipients (1+)
- API administrators
- Notification Category
- None.
- Dashboard Subject
- {api.name}
- Dashboard Content
- Access requested for {contract.environment} environment
- Email Subject
- {author.username} requested API access for {app.name}
- Email Body
<p>Hi {api.name} Administrator,</p> <p>{tenant.name} member {author.username} requested access to the {api.name} in the {contract.environment} environment. Please refer to the details below:</p> <p>App Name: {app.name}<br /> App Version: {app.version}<br /> API Name: {api.name}<br /> API Version: {api.version}</p> <p>To comment on this request, 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}
Example
From: acmepaymentscorp API Platform <platform@acmepaymentscorp.com> Sent: Friday, September 6, 2019 5:05 PM To: jswift@acmepaymentscorp.com Subject: JenMead requested API access for ACME Payments App Hi ACME Payments API Administrator, acmepaymentscorp member JenMead requested access to the ACME Payments API in the Production environment. Please refer to the details below: App Name: ACME Payments App App Version: v1 API Name: ACME Payments API API Version: v1 To comment on this request, please visit your Dashboard. Thanks, The acmepaymentscorp Team
API Contract Requested (Access Request), Sandbox Environment, to App Team Members
Values
- Notification Type
- com.soa.notification.type.api.access.requested.sandbox.appteam
- Trigger
- App team member requests API access (sandbox environment)
- Recipients (1+)
- App team members. This notification goes to all app team members when one of their app team members requests API access.
- Notification Category
- None.
- Dashboard Subject
- {api.name}
- Dashboard Content
- Sandbox access requested and approved for {app.name}
- Email Subject
- Sandbox access to the {api.name} requested and approved for {app.name}
- Email Body
<p>Hi {tenant.name} Member,</p> <p>One of your {tenant.name} app team members, {author.username}, requested access to the {api.name} for development and testing purposes within the {tenant.name} sandbox environment. Please refer to the details below:</p> <p>App Name: {app.name}<br /> App Version: {app.version}<br /> API Name: {api.name} <br /> API Version: {api.version}</p> <p>This request has been approved. You and your team members may now incorporate the {api.name} into your {app.name} app. You may also use the App Sandbox to test your app.</p> <p>For more information, refer to <a href=\"{tenant.theme.console.address}#/home/learnmore?/home/learnmore/collaborate.htm\"> Collaborate </a> in the {tenant.name} online help.</p> <p>To comment on this request, 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 Contract Requested (Access Request), Production Environment, to App Team Members
Values
- Notification Type
- com.soa.notification.type.api.access.requested.production.appteam
- Trigger
- App team member requests API access (production environment)
- Recipients (1+)
- App team members. This notification goes to all app team members when one of their app team members requests API access.
- Notification Category
- None.
- Dashboard Subject
- {api.name}
- Dashboard Content
- Production access requested for {app.name}
- Email Subject
- {author.username} requested production access to the {api.name}
- Email Body
<p>Hi {tenant.name} Member,</p> <p>One of your "{app.name}" team members, {author.username}, requested access to the {api.name} in the {tenant.name} production environment. Please refer to the details below:</p> <p>App Name: {app.name}<br /> App Version: {app.version}<br /> API Name: {api.name} <br /> API Version: {api.version}</p> <p>We'll review this request and get back to you and your team members within 72 hours.</p> <p>To comment on this request, 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}
Example
From: acmepaymentscorp API Platform <platform@acmepaymentscorp.com> Sent: Friday, September 6, 2019 5:22 PM To: jswift@acmepaymentscorp.com Subject: JenMead requested production access to the ACME Payments API Hi acmepaymentscorp Member, One of your "ACME Payments App" team members, JenMead, requested access to the ACME Payments API in the acmepaymentscorp production environment. Please refer to the details below: App Name: ACME Payments App App Version: v1 API Name: ACME Payments API API Version: v1 API Licenses: None API Policies: Bandwidth Quota QOS Policy,Throughput Quota QoS policy We'll review this request and get back to you and your team members within 72 hours. To comment on this request, please visit your Dashboard. Happy Coding, The acmepaymentscorp Team
API Contract Created (Access Request), Sandbox Environment, to App Team Members
Values
- Notification Type
- com.soa.notification.type.api.access.requested.sandbox.notauto.appteam
- Trigger
- App team member requests API access (sandbox environment)
- Recipients (1+)
- App team members. This notification goes to all app team members when one of their app team members requests API access in the sandbox environment.
- Notification Category
- None.
- Dashboard Subject
- {api.name}
- Dashboard Content
- Sandbox access requested for {app.name}
- Email Subject
- {author.username} requested sandbox access to the {api.name}
- Email Body
<p>Hi {tenant.name} Member,</p> <p>One of your "{app.name}" team members, {author.username}, requested access to the {api.name} in the {tenant.name} sandbox environment. Please refer to the details below:</p> <p>App Name: {app.name}<br /> App Version: {app.version}<br /> API Name: {api.name} <br /> API Version: {api.version}</p> <p>To comment on this request, 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 Access Activated by Auto-Connect, in Sandbox environment: to app team members
Values
- Notification Type
- com.soa.notification.type.api.access.activated.sandbox.appteam
- Trigger
- App is auto connected to an API in the Sandbox environment
- Recipients (1+)
- App team members
- Notification Category
- None.
- Dashboard Subject
- {app.name}
- Dashboard Content
- New API access contract created in sandbox environment ({app.name})
- Email Subject
- {app.name}: New API access contract created in sandbox environment
- Email Body
<p>Hi {app.name} Team Member,</p> <p>A new API access contract has been created for your app to connect to an API in the sandbox environment. Please refer to the details below:</p> <p>App Name: {app.name}<br /> App Version: {app.version}<br /> API Name: {api.name} <br /> API Version: {api.version}<br /> Environment: {contract.environment}</p> <p>To reply to this comment, please visit your <a href="{tenant.console.address}#/home/dashboard">Dashboard</a>.</p> <p>Thanks,<br /> The {tenant.name} Team</p> {system.email.footer.html}
API Access Activated by Auto-Connect: to App Team Members
Values
- Notification Type
- com.soa.notification.type.api.access.auto.connect.appteam
- Trigger
- App is auto connected to an API
- Recipients (1+)
- App team members
- Notification Category
- None.
- Dashboard Subject
- {app.name}
- Dashboard Content
- New API access contract created ({api.name})
- Email Subject
- {app.name}: New API access contract created
- Email Body
<p>Hi {app.name} Team Member,</p> <p>A new API access contract has been created for your app to connect to an API. Please refer to the details below:</p> <p>App Name: {app.name}<br /> App Version: {app.version}<br /> API Name: {api.name} <br /> API Version: {api.version}<br /> Environment: {contract.environment}</p> <p>To reply to this comment, please visit your <a href="{tenant.console.address}#/home/dashboard">Dashboard</a>.</p> <p>Thanks,<br /> The {tenant.name} Team</p> {system.email.footer.html}
API Access Approved, Production Environment, to App Team Members
Values
- Notification Type
- com.soa.notification.type.api.access.approved.production.appteam
- Trigger
- The API access for an app is approved (production environment)
- Recipients (1+)
- App team members
- Notification Category
- None.
- Dashboard Subject
- {app.name}
- Dashboard Content
- Production access to the {api.name} has been approved
- Email Subject
- Production access to the {api.name} has been approved
- Email Body
<p>Hi {tenant.name} Member,</p> <p>Production access to the {api.name} has been approved for your app. Please refer to the details below:</p> <p>App Name: {app.name}<br /> App Version: {app.version}<br /> API Name: {api.name} <br /> API Version: {api.version}</p> <p>This change was made by {author.username}, with the following comment:</p> <p>"{comment.text}"</p> <p>To reply to this comment, please visit your <a href="{tenant.theme.console.address}#/home/dashboard">Dashboard</a>.</p> <p>Your app is now ready to enter the production environment. You can enter this environment simply by clicking the Go Live button on the App Home page for your app on {tenant.name}. Before using Go Live, be sure to change the production app to use production endpoints and your production certificate.</p> <p>If you want to continue having Sandbox access after taking the app live, create a new app version in the portal, request Sandbox access for the new app version, and then update sandbox app with new AppID, shared secret and new certificate.</p> <p>Note: If your app is using more than one API, you'll need to wait to enter the production environment until all API access requests are approved.</p> <p>For more information, refer to <a href="{tenant.theme.console.address}#/home/support?/home/support/go_live.htm">Go Live</a> in the {tenant.name} online help.</p> <p>Happy Coding,<br /> The {tenant.name} Team</p> {system.email.footer.html}
API Access Activated, Production Environment, to App Team Members
Values
- Notification Type
- com.soa.notification.type.api.access.activated.production.appteam
- Trigger
- The API access for an app is activated (production environment)
- Recipients (1+)
- App team members
- Notification Category
- NOTIFICATION_TYPE_GROUP_CONTRACT_CHANGE
- Dashboard Subject
- {app.name}
- Dashboard Content
- Production access to the {api.name} has been activated
- Email Subject
- Production access for {app.name} has been activated
- Email Body
<p>Hi {tenant.name} Member,</p> <p>Access to the {tenant.name} production environment has been activated for your app. Please refer to the details below:</p> <p>App Name: {app.name}<br /> App Version: {app.version}<br /> API Name: {api.name} <br /> API Version: {api.version}</p> <p>This change was made by {author.username}, with the following comment:</p> <p>"{comment.text}"</p> <p>To reply to this comment, please visit your <a href="{tenant.theme.console.address}#/home/dashboard">Dashboard</a>.</p> <p>Note: You may now update your app with the production environment endpoint. You'll find the URI for this endpoint in the App Home page for your app.</p> <p>For more information, refer to <a href="{tenant.theme.console.address}#/home/support?/home/support/go_live.htm">Go Live</a> and <a href="{tenant.theme.console.address}#/home/support?/home/support/stay_informed.htm">Stay Informed</a> in the {tenant.name} online help.</p> <p>Happy Coding,<br /> The {tenant.name} Team</p> {system.email.footer.html}
Example
From: acmepaymentscorp API Platform <platform@acmepaymentscorp.com> Sent: Friday, September 6, 2019 5:22 PM To: jswift@acmepaymentscorp.com Subject: Production access for ACME Payments App has been activated Hi acmepaymentscorp Member, Access to the acmepaymentscorp production environment has been activated for your app. Please refer to the details below: App Name: ACME Payments App App Version: v1 API Name: ACME Payments API API Version: v1 This change was made by JenMead, with the following comment: "" To reply to this comment, please visit your Dashboard. Note: You may now update your app with the production environment endpoint. You'll find the URI for this endpoint in the App Home page for your app. For more information, refer to Go Live and Stay Informed in the acmepaymentscorp online help. Happy Coding, The acmepaymentscorp Team
Contract Change Notifications
API Access State Change, Both Environments, to API Admins
Values
- Notification Type
- com.soa.notification.type.api.access.state.change.apiadmin
- Trigger
- The API access for an app changes state (either environment).
- Recipients (1+)
- API administrators
- Notification Category
- NOTIFICATION_TYPE_GROUP_CONTRACT_CHANGE
- Dashboard Subject
- {app.name}
- Dashboard Content
- Access to {api.name} has been {contract.state} in the {contract.environment} environment
- Email Subject
- {api.name}: Access for the {app.name} application has changed state
- Email Body
<p>Hi {api.name} Administrator,</p> <p>Access has changed state for an app. Please refer to the details below:</p> <p>App Name: {app.name}<br /> App Version: {app.version}<br /> 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}, with the following comment:</p> <p>"{comment.text}"</p> <p>To reply to this comment, 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}
Example
From: acmepaymentscorp API Platform <platform@acmepaymentscorp.com> Sent: Friday, September 6, 2019 5:22 PM To: jswift@acmepaymentscorp.com Subject: ACME Payments API: Access for the ACME Payments App application has changed state Hi ACME Payments API Administrator, Access has changed state for an app. Please refer to the details below: App Name: ACME Payments App App Version: v1 API Name: ACME Payments API API Version: v1 Environment: Production State Change: from Approved to Activated. This change was made by JenMead, with the following comment: "" To reply to this comment, please visit your Dashboard. Thanks, The acmepaymentscorp Team
API Access Cancelled (At Request), Both Environments, to API Admins
Values
- Notification Type
- com.soa.notification.type.api.access.cancelled.request.apiadmin
- Trigger
- The API access for an app is cancelled by specific cancellation request (app was not deleted and did not go live) (either environment)
- Recipients (1+)
- API Administrators
- Notification Category
- NOTIFICATION_TYPE_GROUP_CONTRACT_CHANGE
- Dashboard Subject
- {app.name}
- Dashboard Content
- Access to the {api.name} has been canceled in the {contract.environment} environment
- Email Subject
- {contract.environment} access to the {api.name} has been canceled for the {app.name} application
- Email Body
<p>Hi {api.name} Administrator,</p> <p>API access has been canceled for an app. Please refer to the details below:</p> <p>App Name: {app.name}<br /> App Version: {app.version}<br /> 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}, with the following comment:</p> <p>"{comment.text}"</p> <p>To reply to this comment, please visit your <a href="{tenant.theme.console.address}#/home/dashboard">Dashboard</a>.</p> <p>Note: Access to the sandbox environment is automatically canceled if the app goes live or if the app is deleted. However, neither of these conditions applies to this cancellation. If the reason for cancellation isn't clear from the comments, it might be a good idea to reach out to {author.username} to make sure there were no issues with your API.</p> <p>Thanks,<br /> The {tenant.name} Team</p> {system.email.footer.html}
API Access Cancelled (App Deleted), Both Environments, to API Admins
Values
- Notification Type
- com.soa.notification.type.api.access.cancelled.appdeleted.apiadmin
- Trigger
- The API access for an app is automatically cancelled in the sandbox environment because the app was deleted (either environment)
- Recipients (1+)
- API Administrator
- Notification Category
- NOTIFICATION_TYPE_GROUP_CONTRACT_CHANGE
- Dashboard Subject
- {app.name}
- Dashboard Content
- Access to the {api.name} has been canceled in the {contract.environment} environment because the app was deleted
- Email Subject
- {contract.environment} access to the {api.name} has been canceled for the {app.name} application
- Email Body
<p>Hi {api.name} Administrator,</p> <p>API access has been canceled for an app. Please refer to the details below:</p> <p>App Name: {app.name}<br /> App Version: {app.version}<br /> 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}, with the following comment:</p> <p>"{comment.text}"</p> <p>To reply to this comment, please visit your <a href="{tenant.theme.console.address}#/home/dashboard">Dashboard</a>.</p> <p>Note: Access to the {contract.environment} environment for this app was automatically canceled because the app was deleted.</p> <p>Thanks,<br /> The {tenant.name} Team</p> {system.email.footer.html}
Example
From: acmepaymentscorp API Platform <platform@acmepaymentscorp.com> Sent: Thursday, October 3, 2019 4:11 PM To: jswift@acmepaymentscorp.com Subject: Production access to the ACME Payments API has been canceled for the ACME Payments App application Hi ACME Payments API Administrator, API access has been canceled for an app. Please refer to the details below: App Name: ACME Payments App App Version: v1 API Name: ACME Payments API API Version: v1 Environment: Production State Change: from Activated to Inactive - App is Deleted. This change was made by JenniferMeadows, with the following comment: "" To reply to this comment, please visit your Dashboard. Note: Access to the Production environment for this app was automatically canceled because the app was deleted. Thanks, The acmepaymentscorp Team
API Access Cancelled (App Live), Sandbox Environment, to API Admins
Values
- Notification Type
- com.soa.notification.type.api.access.cancelled.applive.sandbox.apiadmin
- Trigger
- The API access for an app is automatically cancelled in the sandbox environment because the app went live in the production environment
- Recipients (1+)
- API Administrator
- Notification Category
- NOTIFICATION_TYPE_GROUP_CONTRACT_CHANGE
- Dashboard Subject
- {app.name}
- Dashboard Content
- Access to the {api.name} has been canceled in the sandbox environment because the app went live
- Email Subject
- Sandbox access to the {api.name} has been canceled for the {app.name} application
- Email Body
<p>Hi {api.name} Administrator,</p> <p>API access has been canceled for an app. Please refer to the details below:</p> <p>App Name: {app.name}<br /> App Version: {app.version}<br /> 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}, with the following comment:</p> <p>"{comment.text}"</p> <p>To reply to this comment, please visit your <a href="{tenant.theme.console.address}#/home/dashboard">Dashboard</a>.</p> <p>Note: Access to the sandbox environment for this app was automatically canceled because the app went live.</p> <p>Thanks,<br /> The {tenant.name} Team</p> {system.email.footer.html}
API Access Suspended, Both Environments, to App Team Members
Values
- Notification Type
- com.soa.notification.type.api.access.suspended.both.appteam
- Trigger
- The API access for an app is suspended (both environments)
- Recipients (1+)
- App team members
- Notification Category
- NOTIFICATION_TYPE_GROUP_CONTRACT_CHANGE
- Dashboard Subject
- {app.name}
- Dashboard Content
- {contract.environment} access to the {api.name} has been suspended
- Email Subject
- {contract.environment} access to the {api.name} has been suspended
- Email Body
<p>Hi {tenant.name} Member,</p> <p>Access to the {tenant.name} {contract.environment} environment has been suspended for your app. Please refer to the details below:</p> <p>App Name: {app.name}<br /> App Version: {app.version}<br /> API Name: {api.name} <br /> API Version: {api.version}</p> <p>This change was made by {author.username}, with the following comment:</p> <p>"{comment.text}"</p> <p>For more information, please contact {author.username}.</p> <p>To reply to this comment, 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}
Example
From: acmepaymentscorp API Platform <platform@acmepaymentscorp.com> Sent: Wednesday, September 4, 2019 3:07 PM To: jswift@acmepaymentscorp.com Subject: Production access to the ACME Payments API has been suspended Hi acmepaymentscorp Member, Access to the acmepaymentscorp Production environment has been suspended for your app. Please refer to the details below: App Name: ACME Payments App App Version: v1 API Name: ACME Payments API API Version: v1 This change was made by JenniferMeadows, with the following comment: "" For more information, please contact JenniferMeadows. To reply to this comment, please visit your Dashboard. Happy Coding, The acmepaymentscorp Team
API Access Resumed, Both Environments, to App Team Members
Values
- Notification Type
- com.soa.notification.type.api.access.resumed.both.appteam
- Trigger
- The API access for an app is resumed after having been suspended (both environments)
- Recipients (1+)
- App team members
- Notification Category
- NOTIFICATION_TYPE_GROUP_CONTRACT_CHANGE
- Dashboard Subject
- {app.name}
- Dashboard Content
- {contract.environment} access to the {api.name} has been resumed
- Email Subject
- {contract.environment} access to the {api.name} has been resumed
- Email Body
<p>Hi {tenant.name} Member,</p> <p>Access to the {tenant.name} {contract.environment} environment has been resumed for your app. Please refer to the details below:</p> <p>App Name: {app.name}<br /> App Version: {app.version}<br /> API Name: {api.name} <br /> API Version: {api.version}</p> <p>This change was made by {author.username}, with the following comment:</p> <p>"{comment.text}"</p> <p>For more information, please contact {author.username}.</p> <p>To reply to this comment, 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}
Example
From: acmepaymentscorp API Platform <platform@acmepaymentscorp.com> Sent: Wednesday, September 4, 2019 3:08 PM To: jswift@acmepaymentscorp.com Subject: Production access to the ACME Payments API has been resumed Hi acmepaymentscorp Member, Access to the acmepaymentscorp Production environment has been resumed for your app. Please refer to the details below: App Name: ACME Payments App App Version: v1 API Name: ACME Payments API API Version: v1 This change was made by JenniferMeadows, with the following comment: "" For more information, please contact JenniferMeadows. To reply to this comment, please visit your Dashboard. Happy Coding, The acmepaymentscorp Team
API Access Resubmitted, Both Environments, to App Team Members
Values
- Notification Type
- com.soa.notification.type.api.access.resubmitted.both.appteam
- Trigger
- An API access request for an app has been resubmitted (both environments)
- Recipients (1+)
- App team members
- Notification Category
- NOTIFICATION_TYPE_GROUP_CONTRACT_CHANGE
- Dashboard Subject
- {app.name}
- Dashboard Content
- API access request to the {api.name} has been resubmitted in the {contract.environment} environment
- Email Subject
- A request to access the {contract.environment} environment for the {api.name} has been resubmitted
- Email Body
<p>Hi {tenant.name} Member,</p> <p>A request to access the {contract.environment} environment for the {api.name} has been resubmitted for your app. Please refer to the details below:</p> <p>App Name: {app.name}<br /> App Version: {app.version}<br /> API Name: {api.name} <br /> API Version: {api.version}</p> <p>This change was made by {author.username}, with the following comment:</p> <p>"{comment.text}"</p> <p>To reply to this comment, 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 Access Rejected, Production Environment, to App Team Members
Values
- Notification Type
- com.soa.notification.type.api.access.rejected.production.appteam
- Trigger
- An API access request for an app has been rejected (production environment)
- Recipients (1+)
- App team members
- Notification Category
- NOTIFICATION_TYPE_GROUP_CONTRACT_CHANGE
- Dashboard Subject
- {app.name}
- Dashboard Content
- Production access to the {api.name} has been rejected
- Email Subject
- Production access to the {api.name} has been rejected
- Email Body
<p>Hi {tenant.name} Member,</p> <p>Access to the {tenant.name} production environment for the {api.name} has been rejected for your app. Please refer to the details below:</p> <p>App Name: {app.name}<br /> App Version: {app.version}<br /> API Name: {api.name} <br /> API Version: {api.version}</p> <p>This change was made by {author.username}, with the following comment:</p> <p>"{comment.text}"</p> <p>For more information, please contact {author.username}.</p> <p>To reply to this comment, 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 Access Cancelled (At Request), Both Environments, to App Team Members
Values
- Notification Type
- com.soa.notification.type.api.access.cancelled.request.both.appteam
- Trigger
- The API access for an app is cancelled by specific cancellation request (app was not deleted and did not go live)
- Recipients (1+)
- App team members
- Notification Category
- NOTIFICATION_TYPE_GROUP_CONTRACT_CHANGE
- Dashboard Subject
- {app.name}
- Dashboard Content
- Access to the {api.name} has been canceled in the {contract.environment} environment
- Email Subject
- Access to the {api.name} has been canceled for the {app.name} application
- Email Body
<p>Hi {tenant.name} Member,</p> <p>API access to the {contract.environment} environment has been canceled for your app. Please refer to the details below:</p> <p>App Name: {app.name}<br /> App Version: {app.version}<br /> API Name: {api.name} <br /> API Version: {api.version}</p> <p>This change was made by {author.username}, with the following comment:</p> <p>"{comment.text}"</p> <p>For more information, please contact {author.username}.</p> <p>To reply to this comment, 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 Access Cancelled, API Deleted (to app team)
Values
- Notification Type
- com.soa.notification.type.api.access.cancelled.apideleted.appteam
- Trigger
- All contracts for an API are cancelled because the API was deleted.
- Recipients (1+)
- App team members for apps contracted with the API
- Notification Category
- None.
- Dashboard Subject
- {app.name}
- Dashboard Content
- API access to {api.name} has been canceled because the API was deleted
- Email Subject
- {app.name}: Access to the {api.name} has been canceled
- Email Body
<p>Hi {tenant.name} Member,</p> <p>API access has been automatically canceled for an app because the API was deleted. Please refer to the details below:</p> <p>App Name: {app.name}<br /> App Version: {app.version}<br /> API Name: {api.name} <br /> API Version: {api.version}<br /> Environment: {contract.environment}<br /> State Change: from {contract.oldstate} to {contract.state}.</p> <p>Thanks,<br /> The {tenant.name} Team</p> {system.email.footer.html}
API Deleted (to API Admin and Business Admin)
Values
- Notification Type
- com.soa.notification.type.api.deleted.apiadmin
- Trigger
- All contracts for an API are cancelled because the API was deleted.
- Recipients (1+)
- API Admins and Business Admins for the API
- Notification Category
- None.
- Dashboard Subject
- {api.name}
- Dashboard Content
- API {api.name} deleted
- Email Subject
- API {api.name} deleted
- Email Body
<p>Hi {tenant.name} Member,</p> <p>{tenant.name} member {author.username} deleted api "{api.name}." All application connections have been cancelled. App team members have been notified.</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:38 PM To: jswift@acmepaymentscorp.com Subject: Api Swagger_Petstore_5_Operations deleted Hi acmepaymentscorp Member, acmepaymentscorp member JenMead deleted api "Swagger_Petstore_5_Operations." All application connections have been cancelled. App team members have been notified. Thanks, The acmepaymentscorp Team
API Version Deleted (to API Admin and Business Admin)
Values
- Notification Type
- com.soa.notification.type.api.version.deleted.apiadmin
- Trigger
- All contracts for an API version are cancelled because the version was deleted.
- Recipients (1+)
- API Admins and Business Admins for the API version
- Notification Category
- None.
- Dashboard Subject
- {api.name} - {api.version} deleted
- Dashboard Content
- Api version {api.name} - {api.version} deleted
- Email Subject
- Api version {api.name} - {api.version} deleted
- Email Body
<p>Hi {tenant.name} Member,</p> <p>{tenant.name} member {author.username} deleted api version "{api.name} - {api.version}." All application connections have been cancelled. App team members have been notified.</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:38 PM To: jswift@acmepaymentscorp.com Subject: Api version Swagger_Petstore_5_Operations - v1 deleted Hi acmepaymentscorp Member, acmepaymentscorp member JenMead deleted api version "Swagger_Petstore_5_Operations - v1." All application connections have been cancelled. App team members have been notified. Thanks, The acmepaymentscorp Team