Create event notification subscriptions (Beta)

This topic describes how to create event notification subscriptions in the Replicated Vendor Portal. For more information about the Event Notifications (Beta) feature, see About event notifications (Beta).

Create an event notification

To create an event notification subscription:

1. In the Vendor Portal, go to Notifications.

2. Click Create Notification.

3. (Optional) Enter a custom name for the subscription. Custom names help you identify subscriptions when you have multiple subscriptions for the same event type. The name is also included in email subjects and webhook payloads.

   Subscription names can contain up to 255 ASCII characters (letters, numbers, and basic punctuation).

4. Select one or more event types to include in the subscription. For more information, see Event types and filters (Beta).

   note

   Alternatively, click Configure with AI instead. With the AI-assisted notification builder, you can describe in natural language the events that you want to be notified about. For example, "Notify me when trial customers upload support bundles" or "Alert me when instances fall more than 3 versions behind on the Stable channel". The AI builder has context of pre-defined event types and filters, but cannot create new event types or filters.

5. (Optional) For each of the events that you selected, click the filter icon to configure event filters. For more information about how the Vendor Portal uses filters to trigger notifications, see Events and filters in About event notifications (Beta).

6. Click Done.

7. Do one of the following, depending on your notification delivery method:

   • For email delivery, enter an email address.
   • For webhook delivery:

     1. Enter a webhook URL. The endpoint must meet the following requirements:

        • Must be able to receive HTTP POST requests
        • Must be publicly accessible (or use a secure tunnel for testing)
        • Must respond with a 2xx status code (200-299) for successful delivery
        • Response time must be less than five seconds

     2. (Recommended) Enter a signing secret for HMAC signature verification. For more information, see Verify webhook signatures.

     3. (Optional) Expand Advanced configuration to add custom HTTP headers for authenticating with your endpoint (for example, Authorization: Bearer token). For more information, see About adding custom HTTP headers.

     4. Click View example to open the webhook payload preview modal and see the exact JSON payload structure your endpoint receives for the selected event types. Click Copy payload to copy the format to your clipboard. For more information, see Webhook payload structure (Beta).

     5. Click Send test webhook to send a sample payload to your endpoint and verify connectivity.

        The test sends an HTTP POST request to your endpoint with a sample payload that matches the structure of a real event. Test webhook payloads include a "test": true field to distinguish them from real event notifications. The data object contains representative sample values (such as "Acme Corp" for customer names) rather than real data from your account.

        The test result displays the HTTP status code and response time, or an error message with troubleshooting guidance. If you configured a signing secret, the test request is signed with HMAC-SHA256 so you can also verify your signature validation logic.

8. Click Create Notification.

9. For email subscriptions, if you used an email address other than your Vendor Portal user account email, follow the instructions in the verification email to validate the email address.

Event notification examples

The following are example event notifications based on common use cases.

Customer success manager: Support bundle uploaded

As a Customer Success Manager, I want to be notified if one of my key customers uploads a support bundle.

• Event Type: Support Bundle Uploaded
• Configuration:
  • Filter - Application: Select your production application
  • Filter - Customer: Select your key enterprise customer (for example, "Acme Corp", "GlobalTech Inc")
  • License Field Condition: tier equals "Enterprise" AND seats greater than or equal to 100
• Delivery Method: Email to your work email (or team email alias)

Sales manager: Trial license expiration

As a Sales Manager, I want to be notified when a trial customer has an impending trial license expiration.

• Event Type: Customer License Expiring
• Configuration:
  • Filter - Application: Select your production application
  • Filter - License Type: "Trial"
• Delivery Method: Email to your work email (or team email alias)

Product manager: Release promoted

As a Product Manager, I want to be notified when a new release version is made available to customers on the Stable channel so that I can engage key customers in adoption follow-up conversations.

• Event Type: Release Promoted
• Configuration:
  • Filter - Application: Select your application
  • Filter - Channel: Select "Stable"
• Delivery Method: Email to pm-team@company.com or webhook to #pm-team channel in Slack

Development leader: Paid customer downloads release assets

As a Development Leader, I want to be notified when a paid customer pulls release assets to initiate a paid install.

• Event Type: Release Asset Downloaded
• Configuration:
  • Filter - Application: Select your application
  • Filter - Channel: Select "Stable"
  • Filter - License Type: "Paid"
  • Filter - Asset Type: Any, or narrow further
• Delivery Method: Email to your work email (or team email alias)

Revenue operations: First software pull for revenue recognition

As a Revenue Operations Manager, receive a notification the first time a customer retrieves software to record the exact revenue recognition timestamp.

• Event Type: Release Asset Downloaded
• Configuration:
  • Filter - Application: Select your application
  • Filter - License Type: "Paid"
  • Filter - Pull Type: "First Pull Only"
• Delivery Method: Webhook to your customer relationship management system

Support engineer: Unhealthy instance alert

As a Support Engineer, you want to be notified when a customer instance has been in an unhealthy state for an extended period so that you can proactively reach out.

• Event Type: Instance State Duration
• Configuration:
  • Filter - State: Select "Unavailable", "Missing", and "Degraded"
  • Filter - Duration: "1 hour"
  • Filter - Application: Select your production application
  • Filter - License Type: "Paid"
• Delivery Method: Webhook to #support-escalations channel in Slack

Operations engineer: Custom metric alert

As an Operations Engineer, you want to receive an alert when a custom metric from a customer instance exceeds a threshold.

• Event Type: Custom Metric Threshold Reached
• Configuration:
  • Metric Name: error_count
  • Operator: Greater Than
  • Threshold Value: 100
  • Frequency: When Changed
  • Filter - Application: Select your application
• Delivery Method: Webhook to your monitoring system or email to ops-team@example.com

Operations lead: Instance instability

As an Operations Lead, you want to be notified when a customer instance is rapidly changing states, which may indicate an underlying infrastructure or configuration issue.

• Event Type: Instance State Flapping
• Configuration:
  • Filter - Minimum State Changes: 5
  • Filter - Time Window: 30 minutes
  • Filter - Application: Select your application
• Delivery Method: Email to ops-team@example.com