Emails Sent to Users

Emails are often sent as users perform actions on the Enterprise Hub. For example, users invited to an organization are sent an email so that they can accept the invitation. As another example, users are sent an email if they would like to reset their password (assuming the password is managed on the Enterprise Hub).

This document lists the types of emails that are sent while using the Enterprise Hub, organized by category.

Requests

Email Type	Trigger Event	Audience	Description
New user request to join organization	A user requests to join an org	Org admins	Contains a link to the Organization Dashboard so an org admin can approve or reject the request.
Request to make API Public	A user requests to make an API Public, assuming Publish Requests are turned on for the environment	Org admins	A notification of the request with a link to the Org Dashboard Approval Page
Request to make API Public Approved	An Org Admin approved a reuqest to make an API public	API provider	A notification of the approval to with a link to the API
Plan Approval Request	User requests access to an API plan which requires approval	API provider	Notifies the API provider about a user's request to subscribe to a plan which requires approval, including the requester's details, and message.
Plan Approval Request	API Provider approves a request to subscribe to an API Plan	API consumer	Notifies the user that their request to subscribe to a plan which requires approval was approved by the API provider.
New user request to join hub	A user requests to join the hub	Environment Admins	Contains a link to the Admin Panel so an environment admin can approve or reject the request.
Workflow request status update	The status of a workflow request changes (for example, Approved or Rejected).	Requestor	Notifies the requestor that the status of their workflow request has changed and provides a link to the Approvals Dashboard where additional details can be reviewed.

User verification

Email Type	Trigger Event	Audience	Description
Email verification	A user signs up for an account, assuming the code verification workflow is enabled.	New user	An email with a code the user will enter to complete the signup process.
Password recovery	A user resets their password.	The user resetting their password.	An email with a link to reset the password.
Email verification (Magic Link)	A user signs up for an account and email verification is configured to use magic links.	New user	An email containing a secure verification link used to confirm ownership of the email address and complete account registration. The link expires after a limited time period.
Two-factor authentication (Magic Link)	A user attempts to sign in and two-factor authentication is required.	Existing user	An email containing a secure authentication link used to complete the login process. The email includes information about link expiration and guidance if the login attempt was not initiated by the recipient.
Failed login attempt	Multiple unsuccessful login attempts are detected for a user account.	Account owner	Alerts the user that repeated login attempts have failed and that additional login attempts may be temporarily restricted. The email provides troubleshooting guidance and security recommendations to help protect the account.

Invitations

Email Type	Trigger Event	Audience	Description
Invite to org	A user is invited to join an organization.	The invited user.	A notification with a link to accept the invite.
API invitation	API provider invites a user, team, or org to consume the API.	API consumer(s)	A notification with a link to accept the invite.
Invite to private plan	A provider invites a user to subscribe to a private subscription plan.	The invited user	A notification with a link to accept the invite.

Notification

Email Type	Trigger Event	Audience	Description
New user invited to organization	A user is invited to an organization.	Org admins	A notification of the new user and a link to Manage Users within the org.
Org invitation response	A user accepts or declines an invite to an org.	Org admins	A notification of a user accepting or declining the invitation with a link to manage users in that organization.
API announcement	An API provider sends an API announcement.	Subscribed API consumers	A notification of the announcement with a link to view it.
API Upload Completed	A OpenAPI Specification file or Postman Collection file is used to create an API	The provider who uploaded the API	A notification that the upload is complete with a link to view the API in the Provider Dashboard
New private message to API provider	A private message is sent to an API Provider.	API provider	A notification to the API owner that they have received a private message regarding the API.
New private message to API consumer	An API provider replies to an API consumer's private message.	API consumer	An alert of the message with a link to their message inbox.
New discussion	A discussion is posted on an API.	API provider	A notification of a new discussion and a link to the discussion page.
API subscription	A user subscribes to an API.	The subscribing API consumer.	A notification of the successful subscription with links on what to do next.
Unsubscribed from API	A consumer unsubscribes from an API or an API is deleted with active subscriptions.	The API consumer that unsubscribed.	A notification of a successful unsubscription.
Payment succeeded	A payment for an API subscription has been successfully processed.	API consumer	A notification with the payment amount and a link to view their transaction history.
API Listing Enhancement Tip	API provider creates or updates an API listing	API provider	Provides tips on enhancing API listings by adding Spotlights to the "About" tab, highlighting potential increase in user subscriptions.
API Access Denial Notification	API provider denies access to an API	API consumer	Informs the user that their access to a specific API has been denied by the provider and provides guidance on the next steps.
API Test Execution Reminder	User creates a new API test	API providers who have created tests	Reminds users to run their newly created API tests, providing instructions for manual execution, automated scheduling, and CI/CD integration.
Log Export Notification	Completion of log export for an application	API consumer	Notifies the user that logs for their application have been exported and are ready for download.
Discussion Comment Notification	A user comments on a followed discussion	API consumer	Alerts the user that a new comment has been added to a discussion they are following.
API subscription	A user subscribes to an API.	API provider	A notification of a new subscription with a link to the API.
API access restricted	An API provider restricts or blocks access to an API for a consumer, application, team, or organization.	Affected API consumer	Notifies the user that access to an API has been restricted and that requests are being denied. The email directs the recipient to contact the API provider for additional information regarding the restriction.

Alerts

Email Type	Trigger Event	Audience	Description
API quota at 100%	An API consumer has used all of the allotted API calls defined by their API subscription plan.	The API consumer that has reached their quota.	A notification that the API consumer hit their quota and a link to upgrade their plan.
API quota at 85%	An API consumer has used 85% of the allotted API calls defined by their API subscription plan.	The API consumer that has reached 85% of their quota.	A notification that the API consumer hit 85% of their quota.
Payment Failure Notifications	Failed attempt to charge a credit card for API subscription	API consumer	A series of emails that Inform users about a failed payment attempts for their API subscription, warns about service suspension, and provides instructions to update the payment method.
Configurable alerts	An alert has been triggered based on the settings within the Provider Dashboard. See Alerts .	API provider	A notification to the API provider. The email will contain which alert has been triggered.