docs(integrations): correct emitted event names across integration pages - #255
Open
Makisuo wants to merge 1 commit into
Open
docs(integrations): correct emitted event names across integration pages#255Makisuo wants to merge 1 commit into
Makisuo wants to merge 1 commit into
Conversation
The Mixpanel page was recently corrected because it promised sw_-prefixed event names while the shipped code emits Title Case. The same defect affected other pages. Audited every integration in the integration-router against mapEventType; no emitted names were changed, only the docs. Corrected — the documented names were never emitted: - statsig: claimed sw_* throughout; really emits Title Case. Rewrote all four tables with Statsig Event + Identifier columns and a Matching Order section. - amplitude: documented Trial Conversion, Subscription Renewal, Trial Cancellation and [Superwall] Test — really Trial Converted, Renewal, Trial Cancelled, Test Event. Also fixed revenueType, which drops the [Superwall] prefix, and the insert_id format. - firebase: same stale wording family (trial_conversion, subscription_renewal, *_cancellation). Documented the real derivation, including that only whitespace is replaced, so Non-Renewing Purchase emits non-renewing_purchase. Verified accurate, then filled in gaps: - customer-io and meta-conversion-api genuinely receive sw_* names. Added the identifier framing, the missing rows, and a Matching Order section. Meta's action_source was documented as "app"; the code sends "system_generated". - discord titles were right but the table was incomplete and the colors were wrong: the trial-period check runs before the negative check, so a cancelled, refunded or expired trial is Blue rather than Red, and a free intro start is Green rather than Blue. Also removed all eventNameMappings documentation. Event names are fixed per integration — there is no per-customer renaming — so the settings rows, config examples, Discord's "Custom Event Names" section and the related troubleshooting entries described a capability that is not offered. posthog was already correct and is untouched. Internal integration-router docs and the stale statsig fixture are corrected in the matching superwall/paywall-next PR. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Deploying with
|
| Status | Name | Latest Commit | Preview URL | Updated (UTC) |
|---|---|---|---|---|
| ✅ Deployment successful! View logs |
superwall-docs | 9bcd4f0 | Commit Preview URL Branch Preview URL |
Aug 06 2026, 11:58 AM |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
The Mixpanel page was recently corrected because it promised
sw_-prefixed event names (sw_trial_start) while the shipped code emits Title Case (Trial Start). The same defect affected other pages.I audited every integration in
apps/integration-router/src/integrations/againstmapEventType. No emitted event names were changed — renaming would break existing customers' dashboards. Only the docs move.The root cause:
mapEventTypereturns botheventType(sw_*) andeventTypePretty(Title Case). Integrations that passeventTypePrettyas the default to the name resolver emit Title Case; those that passeventTypeemitsw_*. The docs were written as if every integration did the latter.What each integration actually emits
[Superwall])eventTypePrettylowercased with whitespace →_sw_*Subscribe/StartTrial/Purchase, elsesw_*verbatim🤩 Trial Start)sng_*/ snake_caseCorrected — documented names that were never emitted
sw_*throughout.statsig-integration.spec.ts:81already assertsSubscription Start. Rewrote all four tables with Statsig Event + Identifier columns and a Matching Order section.Trial Conversion,Subscription Renewal,Trial Cancellation,[Superwall] Test. ReallyTrial Converted,Renewal,Trial Cancelled,Test Event. Also fixedrevenueType(drops the[Superwall]prefix) and theinsert_idformat.Non-Renewing Purchaseemits asnon-renewing_purchase, hyphen intact.Verified accurate, then filled in gaps
sw_*claims are genuine. Added identifier framing, missing rows, Matching Order. Meta'saction_sourcewas documented as"app"; the code sends"system_generated".getDiscordEmbedColorruns before the negative check, so a cancelled/refunded/expired trial is Blue, not Red, and a free intro start is Green, not Blue.eventNameMappings removed
All
eventNameMappingsdocumentation is gone: settings rows, config examples, Discord's "Custom Event Names" section and the related troubleshooting entries. Event names are fixed per integration — there is no per-customer renaming — so those sections described a capability that isn't offered.Companion PR
Internal
integration-routerdocs and the stale statsig fixture: superwall/paywall-nextdocs/integration-event-name-accuracy.🤖 Generated with Claude Code