Get Email Notifications

API Hub for Design sends email notifications when specific events occur. You will receive notifications for any APIs and domains you are subscribed to. API and domain owners and collaborators are subscribed to notifications by default. Users can also subscribe to and unsubscribe from any API or domain they have access to. Anonymous users will need a API Hub for Design account in order to subscribe to API notifications.Resource Roles

Email notifications come from info@swaggerhub.com.

Events that trigger notifications

Notifications are not sent to the user who triggered the notifications unless otherwise noted.

You will receive a notification when:

  • You are added to an organization.Manage Resource Access

  • Your role in the organization changes.

  • You are added to an API or domain as a collaborator.Resource Roles

Users subscribed to an API or domain (including the owner and collaborators) will receive a notification when:

  • A version of the API or domain is published, unpublished or deleted.

  • The API or domain is renamed.

  • The API or domain is transferred to another owner.

  • The API or domain is deleted.

  • A new version is added to an API or domain.

  • API or domain visibility is changed.Public and Private APIs

  • The default version of the API changes.

Collaborators will receive notifications when:Resource Roles

  • Comments are added, replied to, resolved or reopened.Comments

If you refer to external domains in your APIs and domains, you will receive a notification when the domain you refer to is renamed, unpublished, deleted or changed from public to private.

When GitHub Push fails, an email is sent to the Notification Email specified in the integration settings.GitHub Push (Legacy)

When an organization is renamed, a notification is sent to all members.

Subscribe to notifications

When you create an API or domain, or when you are added as a collaborator to an API (domain), you are automatically subscribed to notifications from this API (domain). You can also subscribe to other users’ APIs and domains that you see on API Hub for Design, for example, to get notified when a new version of an API is available.Creating a New API

API_screenshot_notifications_01.png

You can also subscribe to notifications from the API list in search results or MY hub:

Enabling notifications

Unsubscribe from notifications

Unsubscribe from an API or domain

If you no longer want to receive notifications from an API or domain, you can unsubscribe in several ways:

  • Open the API or domain page and click the notifications.png icon. It will become hollow: disabled-notifications.png.

  • Open My APIs, find this API or domain and click the notifications.png icon. It will become hollow: disabled-notifications.png.

  • Click the “unsubscribe” link in an email notification and confirm your resignation from the subscription.

Unsubscribe from all API notifications

To stop receiving notifications for all APIs and domains you are currently subscribed to:

  1. When viewing an email notification, click the “unsubscribe” link. This will open the Unsubscribe page.

  2. Click the “click here” link at the bottom of the page.

    Unsubscribing from all APIs and domains
Publication date: