Skip to content

Replace HelpScout customFields IDs with semantic metaFields#2859

Merged
ChiragAgg5k merged 1 commit intomainfrom
fix/helpscout-metafields-consistency
Feb 16, 2026
Merged

Replace HelpScout customFields IDs with semantic metaFields#2859
ChiragAgg5k merged 1 commit intomainfrom
fix/helpscout-metafields-consistency

Conversation

@ChiragAgg5k
Copy link
Member

@ChiragAgg5k ChiragAgg5k commented Feb 16, 2026

Summary

  • Removed all raw HelpScout custom field IDs (41612, 48492, 48491, 56023, etc.) from frontend API calls
  • All VARS.GROWTH_ENDPOINT calls now use metaFields with semantic key names instead of customFields with provider-specific IDs
  • The backend (growth server) handles mapping named keys to HelpScout field IDs

Files changed

  • supportWizard.svelte — replaced customFields with metaFields: category, orgId, projectId, severity, billingPlan
  • feedback.ts — removed customFields, merged into metaFields: currentPage, npsScore, billingPlan (alongside existing source, orgId, projectId, userId). Removed resolved TODOs.
  • Soc2Modal.svelte — removed customFields, merged into metaFields: category, userName, orgId, userId
  • BAAModal.svelte — same as SOC-2

Companion PR

Test plan

  • Submit a support ticket via the support wizard and verify it creates a HelpScout conversation with correct custom fields
  • Submit feedback and verify HelpScout fields (currentPage, npsScore, billingPlan) are populated
  • Submit SOC-2 and BAA requests and verify all fields appear in HelpScout
  • Verify file attachments still work in the support wizard

Summary by CodeRabbit

  • Refactor
    • Restructured internal data handling in feedback submission, Business Associate Agreement requests, SOC2 compliance requests, and support wizard for improved consistency and scalability.

Move all HelpScout field ID references out of frontend API calls.
All GROWTH_ENDPOINT calls now use metaFields with named keys
(category, orgId, severity, etc.) instead of customFields with
raw HelpScout IDs. The backend handles the ID mapping.
@appwrite
Copy link

appwrite bot commented Feb 16, 2026

Console (appwrite/console)

Project ID: 688b7bf400350cbd60e9

Sites (1)
Site Status Logs Preview QR
 console-stage
688b7cf6003b1842c9dc
Ready Ready View Logs Preview URL QR Code

Tip

Build commands execute in runtime containers during deployment

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Feb 16, 2026

No actionable comments were generated in the recent review. 🎉


Walkthrough

This pull request refactors payload structures across four files that submit data to backend endpoints. The changes consistently replace customFields arrays (containing id-value pairs) with metaFields objects containing structured metadata fields. Affected files include a feedback submission store and three modal components for BAA, SOC-2, and support wizard requests. No public API signatures are modified, and error handling and control flow remain unchanged. The endpoint destinations and other payload fields are retained.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

🚥 Pre-merge checks | ✅ 3 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The PR title accurately summarizes the main change: replacing HelpScout customFields with semantic metaFields across multiple files, which is the core objective of this pull request.
Merge Conflict Detection ✅ Passed ✅ No merge conflicts detected when merging into main

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing touches
  • 📝 Generate docstrings
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch fix/helpscout-metafields-consistency

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR refactors the HelpScout integration by replacing provider-specific custom field IDs with semantic field names in metaFields. This improves maintainability by decoupling the frontend from HelpScout's internal field ID structure, with the backend (growth server) now handling the mapping between semantic names and provider-specific IDs.

Changes:

  • Replaced all customFields arrays containing hardcoded HelpScout field IDs with metaFields objects using semantic key names
  • Removed resolved TODO comments about backend support for billingPlan and source fields
  • Standardized field naming conventions across all GROWTH_ENDPOINT API calls

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.

File Description
supportWizard.svelte Migrated 5 custom fields (category, orgId, projectId, severity, billingPlan) to metaFields in support ticket submission
feedback.ts Migrated 3 custom fields (currentPage, npsScore, billingPlan) to metaFields and removed resolved TODOs
Soc2Modal.svelte Migrated 4 custom fields (category, userName, orgId, userId) to metaFields for SOC-2 compliance requests
BAAModal.svelte Migrated 4 custom fields (category, userName, orgId, userId) to metaFields for BAA requests

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@ChiragAgg5k ChiragAgg5k merged commit e007707 into main Feb 16, 2026
10 checks passed
@ChiragAgg5k ChiragAgg5k deleted the fix/helpscout-metafields-consistency branch February 16, 2026 09:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants