Template Urn Naming Convention Standard
Version Control
| Version | Date | Who | What |
|---|---|---|---|
| 0.1 | 18 Nov 2025 | Saji Varghese & Amar Gurung | Accepted |
Document Overview
| Decision required | How to name the template urn in flutter-relevant-messaging? |
|---|---|
| Decision Outcome | agreed to use brand:messaging:promotionName:full_screen/toast |
| Owner | Saji Varghese & Amar Gurung |
| Current Status | Accepted |
| Decider(s) |
1. Context
The original naming convention for message URN templates followed the format ppb:messaging:promotionName:type (e.g., ppb:messaging:priceBoost:toast). This worked well when only one or two brands were using the system. However, now that the flutter-relevant-messaging service is used by all three brands—SGB (Sky Bet), PP (Paddy Power), and BF (Betfair)—the old format makes it difficult to identify which templates belong to a specific brand.
2. Considered Options
- Add
flutter:messaging:brand:promotionName:full_screen/toast - Add
ppb:messaging:brand:promotionName:full_screen/toast
3. Decision
To solve this scaling problem and ensure immediate brand identification, it was decided to revise the convention by making the brand code a dynamic component.
Decision: Adopt the new format: brand:messaging:promotionName:full_screen/toast Example: sgb:messaging:priceBoost:toast
Decision also has been made to only follow the format for the new templates and leave the existing templates with it's original name.
4. Consequences
Positive
- Instant Brand Identification: The brand is now the first element in the URN (e.g., sgb:, pp:), allowing any engineer , product manager or QA specialist to immediately identify the owning brand without needing to cross-reference other documentation or systems.
- Improved Discoverability & Filtering: Searching, sorting, and filtering templates by brand becomes trivial. This will significantly speed up debugging, auditing, and development workflows within shared repositories and monitoring tools.
Negative
- Transition & Migration Overhead: May need to migrate the existing templates to new format, but its decided we are leaving the old ones just like that. This may cause confusion and others may follow the old format.