Skip to content

Notifications for an application

Automated Notifications can be configured for events (e.g. code deployments) that occur on an application’s environments.

Manage Notifications for an application’s environments in the VIP Dashboard for that application. Notifications for an application can be configured per-environment type (production vs. non-production), or for a single specific environment of that application.

Access

Prerequisite

To view, add, edit, or remove Notifications for an application—or to add a new Destination for an application’s Notifications—a user must have at minimum an Org member role or an App write role for that application.

  1. Navigate to the VIP Dashboard for an application.
  2. Select an environment from the environment dropdown located at the upper left of the VIP Dashboard.
  3. Select “Access & Routing” from the sidebar navigation at the left of the screen.
  4. Select Notifications from the navigation submenu.

Add a Notification

Add a Notification for one or more environments of an application.

  1. Select the button labeled “Add Notification” located in the upper right of the panel.
  2. Select the environment(s) for which the Notification will be enabled. Configure one of the available environment options:
    • Either Choose an environment type: Enable the radio button for either the production environment for all of an organization’s applications, or the non-production environment(s) for all of an organization’s applications.
    • Or Choose a specific environment: Select a specific environment of a single application by environment name (e.g., Preprod, Develop, QA1).
  3. Choose Notification Type: Configure the type of environment event to be communicated in the Notification.
    • Deployments: Send a notification for the status of a deployment. Select the checkbox labeled “Deployments” located in the upper right of the “Deployments” configuration box. By default, this will enable Notifications to be sent for all deployment status types. (e.g., “Deployment success”, “Deployment failure”). To configure the Notification to be sent for specific status types:
      • Select the button labeled “Show options“.
      • Select 1 or more of the displayed deployment status types.
  4. Choose Destination: Select a Destination for this Notification from the list of options in the dropdown menu.
    • A button labeled “+ Add New Destination” will be available for users with at least an Org member role or an App write role for that application. Select this button to add a new Destination for the application.
  5. Select the button labeled “Add Notification” located in the upper right of the panel to add the Notification with the selected configurations.

Enable or disable a Notification

Configured Notifications that are listed in the application’s Notifications panel can be selectively enabled or disabled. A toggle button is displayed to the right of each listed Notification. Select the button to enable (“✔️”) or disable (“✖️”) the Notification.

Edit a Notification

Select the linked text “Edit” located to the right of a listed Notification. All configuration options for a Notification can be modified. To save any changes made to the configuration of a Notification, select the button labeled “Update Notification” located in the upper right of the panel.

Remove a Notification

Select the linked text “Remove” located to the right of a listed Notification. A dialog titled “Remove Notification” will display a summary of the Notification’s configuration, and require confirmation from the user before the Notification is removed. To proceed with the removal of the Notification, select the button labeled “Remove Notification“.

Last updated: January 22, 2024

Relevant to

  • Node.js
  • WordPress