Skip to content

Commit b076cc4

Browse files
authored
Merge pull request #3916 from replicatedhq/amber/per-license-type-revenue-milestones
docs: add per-license-type filters for revenue recognition events
2 parents 253c0de + 8c9b3d1 commit b076cc4

2 files changed

Lines changed: 27 additions & 7 deletions

File tree

docs/reference/notifications-events-filters.md

Lines changed: 21 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,22 @@ When a vendor sends an Enterprise Portal invite to a user
4646

4747
### Enterprise Portal Access Granted
4848

49-
When the first user accesses the Enterprise Portal for that customer team
49+
When a user accesses the Enterprise Portal for a customer team.
50+
51+
The following table describes the available filters for the Enterprise Portal Access Granted event type:
52+
53+
| Filter | Required | Options |
54+
|--------|----------|---------|
55+
| Application | No | Any application in your account |
56+
| Customer | No | Any customer for the selected application |
57+
| Access Method | No | Invite, Self-Signup, SAML JIT |
58+
| License Type | No | Paid, Trial, Community, Development |
59+
| Access Type | No | Any Access, First Access for Selected License Type |
60+
61+
The **Access Type** filter controls whether the notification fires on every access or only on first-access milestones per license type:
62+
63+
- **First Access for Selected License Type**: The notification fires the first time a user accesses the Enterprise Portal for a customer with a specific license type. Use this with the **License Type** filter to track access milestones per license type. For example, combining this with License Type "Paid" fires when a customer first accesses the portal on a paid license, even if they previously accessed it on a trial.
64+
- **Any Access** (default): The notification fires on every access event.
5065

5166
### Enterprise Portal User Joined
5267

@@ -171,15 +186,16 @@ The following table describes the available filters for the Release Assets Downl
171186
| Customer | No | Any customer for the selected application |
172187
| License Type | No | Paid, Trial, Community, Development |
173188
| Asset Type | No | Helm Chart, Embedded Cluster Bundle, Proxy Registry Image |
174-
| Pull Type | No | First Pull Only, Any Pull |
189+
| Pull Type | No | First Pull Only, First Pull for Selected License Type, Any Pull |
175190

176-
The **Pull Type** filter controls whether the notification fires on every pull or only the first time a customer pulls any software asset:
191+
The **Pull Type** filter controls whether the notification fires on every pull or only on first-pull milestones:
177192

178-
- **First Pull Only**: The notification fires only when a customer pulls a release asset for the first time, across all asset types.
193+
- **First Pull Only**: The notification fires only when a customer pulls a release asset for the very first time, regardless of license type. If a customer first pulls on a trial license, this will not fire again when they convert to a paid license.
194+
- **First Pull for Selected License Type**: The notification fires the first time a customer pulls a release asset with a specific license type. Use this with the **License Type** filter to track milestones per license type. For example, combining this with License Type "Paid" fires the first time a customer pulls on a paid license, even if they previously pulled on a trial.
179195
- **Any Pull** (default): The notification fires on every pull. This is equivalent to leaving the filter unset, and all existing subscriptions behave this way.
180196

181197
:::note
182-
First pull tracking is forward-only. Customers who pulled software before this feature shipped will have `is_first_customer_pull: false` on all subsequent pulls.
198+
First pull tracking is forward-only. Customers who pulled software before March 18, 2026 will have `is_first_customer_pull: false` on all subsequent pulls. Per-license-type milestones only track pulls that occur after March 27, 2026.
183199
:::
184200

185201
## Support events

docs/vendor/event-notifications-create.mdx

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -123,15 +123,19 @@ As a Development Leader, I want to be notified when a paid customer pulls releas
123123

124124
### Revenue operations: First software pull for revenue recognition
125125

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

128128
- **Event Type:** Release Asset Downloaded
129129
- **Configuration:**
130130
- Filter - Application: Select your application
131131
- Filter - License Type: "Paid"
132-
- Filter - Pull Type: "First Pull Only"
132+
- Filter - Pull Type: "First Pull for Selected License Type"
133133
- **Delivery Method:** Webhook to your customer relationship management system
134134

135+
:::note
136+
Use "First Pull for Selected License Type" rather than "First Pull Only" if customers may start on a trial before converting to a paid license. "First Pull Only" tracks the first-ever pull regardless of license type. If a customer pulls on a trial license first, the notification will not fire again after they convert to paid. "First Pull for Selected License Type" tracks milestones per license type. The notification fires the first time the customer pulls software with a paid license, even if they previously pulled on a trial.
137+
:::
138+
135139
### Support engineer: Unhealthy instance alert
136140

137141
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.

0 commit comments

Comments
 (0)