Skip to main content

About event notifications (Beta)

This topic provides an overview of the Event Notifications (Beta) feature, which allows you to set up notifications for key events from the Vendor Portal.

Overview

You can define and subscribe to notifications in the Vendor Portal to receive alerts when specific events occur. Built-in event types and filters allow you to create highly-targeted notifications for the events that matter most to your workflow. For example, Customer Success Managers could get an email notification when a key customer uploads a support bundle. Or, Support Engineers could get a Slack notification when a customer instance has been in an unhealthy state for an extended period.

The Vendor Portal queues events to Amazon Simple Queue Service (SQS) for reliable processing, and matches notifications against your custom event filters in real time. You can receive notifications through email or webhook. For information about how to create and subscribe to event notifications, see Create event notification subscriptions (Beta).

Events and filters

This section describes the types of events and filters that are available for creating notifications. It also describes the logic that the Vendor Portal uses to determine if a given event satisfies the conditions to send a notification.

Supported event types

You can create notifications for various types of events, including events related to application instances, customers, support bundles, releases, and channels. For example, you can get a notification when an instance reaches a Ready state in the customer environment, when the customer uploads a new support bundle, or when a customer license is expiring soon.

For the full list of available event types and event-specific filters, see Event types and filters (Beta).

Multi-event notifications

Each notification can have one or more events. For notifications that include multiple events, the Vendor Portal evaluates each event independently against its filters. If any event matches its filters, then the Vendor Portal triggers a notification.

For example, if you create a notification with both the Release Created and Release Promoted events and no additional filters, then the Vendor Portal sends a notification any time a release is created or promoted.

Event filters

You can configure a unique set of filters for each event that you add to a notification. An event must match all its filters to trigger the notification (AND logic).

The filters available depend on the event type. All events support filtering by application name. Other common filters that apply to most event types include the channel, customer name, and license type. For more information, see Event types and filters (Beta).

Filters with multiple values

If a single filter has multiple values, then the event must match any of the selected values (OR logic) to satisfy the filter.

For example, if you select both Paid and Community for the License type filter, then the filter is satisfied if the license type is either Paid or Community.

Custom license field filters

When you specify multiple custom license field filters, all conditions must match for the notification to trigger (AND logic). For example, if you add filters for seats > 99 and tier == Enterprise, then the value of the seats custom license field must be greater than 99 and the value of the tier custom license field must be Enterprise to trigger a notification.

The Vendor Portal supports filtering by custom license fields for the following event types:

  • Customer events (Customer Created, Customer Updated, Customer Archived, Customer Unarchived, Customer License Expiring)
  • Instance events (Instance Created, Instance Ready, Instance Upgrade Started, Instance Upgrade Completed, Instance Version Behind, Instance Inactive, Instance State Duration, Instance State Flapping)
  • Support Bundle events (Support Bundle Uploaded, Support Bundle Analyzed)

For information about how to create custom license fields, see Manage custom license fields in Create and manage customers.

RBAC requirements

Roles with write access (Admin, Support Engineer, Sales, or custom roles) can create and manage their own notifications. They can also view notifications created by others.

Only Admins can create and manage notifications created by other team members.

For teams that use custom RBAC policies, the following permissions are available:

  • team/notifications/**: Full access to all notification features including managing other users' subscriptions
  • team/notifications/subscriptions/read: View all team subscriptions
  • team/notifications/subscriptions/create: Set up their own alerts
  • team/notifications/subscriptions/update: Modify their own alerts
  • team/notifications/subscriptions/delete: Remove their own alerts
  • team/notifications/types/list: See available event types
  • team/notifications/events/read: View notification history

For more information, see Configure RBAC policies.

Limitations

Event Notifications (Beta) has the following limitations:

  • Notification events generated are not included in the Instance Bulk Data Export API
  • It is possible to create a notification for some resource types, such as customers and support bundles, but not to access the notification linked asset due to your allowed user permissions. This is most likely to impact teams with enterprise and custom RBAC policies. For example, someone with the Sales RBAC role can create a notification for a customer uploading a support bundle, but does not have permission to view the linked specific customer bundle due to their RBAC role permissions.
  • The Release Assets Downloaded event might fire per chart or image if the customer pulls each separately as part of your installation instructions. Because release assets might be shared across many of your release versions, the Vendor Portal records the event at the chart/image level and does not associate the event with a specific release version. If you find this alert too noisy, reach out to us to further discuss your specific use case.

Comparison to instance notifications (Classic)

Event Notifications (Beta) is the next generation of instance notification functionality in the Vendor Portal. Compared to Instance Notifications (Classic), Event Notifications offers more event types, fine-grained filtering, flexible delivery routing, notification history tracking, and better access control.

You can use Event Notifications (Beta) concurrently with Instance Notifications (Classic) while you evaluate and transition.

The following table compares the functionality offered by Instance Notifications (Classic) and Event Notifications (Beta):

FeatureInstance Notifications (Classic)Event Notifications (Beta)
Event TypesThree event types: App Status, System Events, Custom MetricsMore than 20 event types across six categories
ScopePer-instance subscriptionsTeam-wide with flexible filtering
DeliverySlack (1 team webhook) + Email (1 user)Per notification email or webhook
FilteringInstance-level onlyMulti-field filters (app, customer, channel, etc.)
PermissionsUser-scopedTeam-scoped RBAC
Webhook SecurityBasicHMAC-SHA256 signing
Webhook TestingManualBuilt-in payload preview and test webhook button
Notification HistoryMinimalFull delivery attempt tracking with event details