Singular integration #2637

devkiran · 2025-07-11T04:56:19Z

Summary by CodeRabbit

New Features
- Added support for Singular integration, including new API endpoints to process Singular lead and sale webhooks.
- Introduced new utility to detect Singular tracking URLs and enhanced URL handling for tracking requests.
- Added a new environment variable for Singular webhook authentication.
- Expanded accepted payment processors to include RevenueCat.
Improvements
- Refactored lead and sale tracking endpoints to use centralized functions, simplifying request handling and improving maintainability.
- Enhanced type safety across the app by introducing new TypeScript types for click and lead events.
- Updated integration management page to always render fresh data.
Bug Fixes
- Improved error handling and logging for Stripe customer updates.
Chores
- Updated example environment file and integration creation script for Singular.

vercel · 2025-07-11T04:56:24Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Updated (UTC)
dub	✅ Ready (Inspect)	Visit Preview	Jul 18, 2025 5:06pm

coderabbitai · 2025-07-11T04:56:25Z

Walkthrough

A new Singular integration was implemented, including webhook endpoints, event tracking, and URL handling. Core lead and sale tracking logic was refactored into reusable functions, simplifying API route handlers. Type definitions were standardized and decoupled from Zod schemas. Middleware and utility functions were updated to support Singular-specific tracking and URL patterns. Minor improvements and adjustments were made to page caching, error logging, and integration scripts.

Changes

File(s)	Change Summary
`apps/web/.env.example`	Added `SINGULAR_WEBHOOK_TOKEN` environment variable.
`apps/web/app/(ee)/api/singular/webhook/route.ts`	Added Singular webhook API route with GET/HEAD handlers, event validation, and workspace lookup.
`apps/web/app/(ee)/api/stripe/integration/webhook/checkout-session-completed.ts` `apps/web/lib/actions/partners/create-commission.ts` `apps/web/lib/integrations/shopify/create-sale.ts` `apps/web/lib/webhook/transform.ts`	Replaced Zod-inferred types with explicit `ClickEventTB` and `LeadEventTB` type aliases.
`apps/web/app/(ee)/api/track/lead/route.ts` `apps/web/app/(ee)/api/track/sale/route.ts`	Refactored route handlers to delegate all tracking logic to new `trackLead` and `trackSale` functions.
`apps/web/lib/api/conversions/track-lead.ts`	Added new `trackLead` function implementing full lead tracking workflow.
`apps/web/lib/api/conversions/track-sale.ts`	Added new `trackSale` function implementing full sale tracking workflow.
`apps/web/lib/integrations/singular/track-lead.ts`	Added module for parsing/handling Singular lead events and invoking internal lead tracking.
`apps/web/lib/integrations/singular/track-sale.ts`	Added module for parsing/handling Singular sale events and invoking internal sale tracking.
`apps/web/lib/middleware/link.ts`	Added Singular tracking URL detection for click ID caching; optimized user agent extraction.
`apps/web/lib/middleware/utils/get-final-url.ts`	Appends Singular-specific query params (`cl`, `ua`, `ip`) to URLs; imports new helpers.
`apps/web/lib/middleware/utils/is-singular-tracking-url.ts`	Introduced helper to detect Singular tracking URLs by domain suffix.
`apps/web/lib/types.ts`	Added `ClickEventTB` and `LeadEventTB` types inferred from Zod schemas.
`apps/web/lib/zod/schemas/sales.ts`	Added `"revenuecat"` as a valid `paymentProcessor` value in sale tracking schema.
`apps/web/scripts/create-integration.ts`	Changed integration creation from "Slack" to "Singular"; updated fields and removed placeholders.
`apps/web/app/app.dub.co/(dashboard)/[slug]/settings/(basic-layout)/integrations/[integrationSlug]/manage/page.tsx`	Exported `revalidate = 0` to disable static revalidation for the page.
`apps/web/lib/partnerstack/update-stripe-customers.ts` `apps/web/lib/tolt/update-stripe-customers.ts`	Replaced async logging with direct `console.error` for multiple Stripe customer errors.

Sequence Diagram(s)

Singular Webhook Event Flow

sequenceDiagram
    participant Singular
    participant API as /api/singular/webhook
    participant DB as Database
    participant Lead as trackLead
    participant Sale as trackSale

    Singular->>API: GET /api/singular/webhook?...
    API->>API: Validate SINGULAR_WEBHOOK_TOKEN and query params
    API->>DB: Lookup workspace by dub_workspace_id
    API->>API: Map event_name to internal type
    alt event_name == "lead"
        API->>Lead: trackLead(params, workspace)
        Lead-->>API: Lead tracking result
    else event_name == "sale"
        API->>Sale: trackSale(params, workspace)
        Sale-->>API: Sale tracking result
    end
    API-->>Singular: JSON { "OK": true }

Lead/Sale Tracking Delegation

sequenceDiagram
    participant Route as /api/track/lead or /api/track/sale
    participant Logic as trackLead/trackSale
    participant DB as Database
    participant Redis as Redis
    participant Webhook as Workspace Webhook

    Route->>Logic: Call with parsed params and workspace
    Logic->>Redis: Deduplication (lead/sale)
    Logic->>DB: Lookup or upsert customer/lead/sale
    Logic->>Webhook: Send event notification
    Logic-->>Route: Tracking result
    Route-->>Client: JSON response

Poem

🐇
A Singular hop, a leap through the code,
Webhooks and tracking, in neat new abode.
Types now explicit, Zod takes a rest,
Middleware sniffs out the Singular quest.
With leads and with sales, the logic’s now lean—
Oh what a fine integration machine!

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 9874ea8 and 69025d4.

📒 Files selected for processing (3)

apps/web/app/app.dub.co/(dashboard)/[slug]/settings/(basic-layout)/integrations/[integrationSlug]/manage/page.tsx (1 hunks)
apps/web/lib/partnerstack/update-stripe-customers.ts (0 hunks)
apps/web/lib/tolt/update-stripe-customers.ts (0 hunks)

💤 Files with no reviewable changes (2)

apps/web/lib/partnerstack/update-stripe-customers.ts
apps/web/lib/tolt/update-stripe-customers.ts

🧰 Additional context used

🧠 Learnings (2)

📓 Common learnings

Learnt from: devkiran
PR: dubinc/dub#2637
File: apps/web/app/(ee)/api/singular/webhook/route.ts:0-0
Timestamp: 2025-07-17T06:41:45.598Z
Learning: In the Singular integration (apps/web/app/(ee)/api/singular/webhook/route.ts), the event names in the singularToDubEvent object have intentionally different casing: "Copy GAID" and "copy IDFA". This casing difference is valid and should not be changed, as these are the correct event names expected from Singular.

apps/web/app/app.dub.co/(dashboard)/[slug]/settings/(basic-layout)/integrations/[integrationSlug]/manage/page.tsx (1)

Learnt from: TWilson023
PR: dubinc/dub#2614
File: apps/web/ui/partners/design/previews/lander-preview.tsx:181-181
Timestamp: 2025-07-09T20:52:56.592Z
Learning: In apps/web/ui/partners/design/previews/lander-preview.tsx, the ellipsis wave animation delay calculation `3 - i * -0.15` is intentionally designed to create negative delays that offset each dot's animation cycle. This pattern works correctly for the intended ellipsis effect and should not be changed to positive incremental delays.

🧬 Code Graph Analysis (1)

apps/web/app/app.dub.co/(dashboard)/[slug]/settings/(basic-layout)/integrations/[integrationSlug]/manage/page.tsx (3)

apps/web/app/app.dub.co/(dashboard)/[slug]/settings/(basic-layout)/integrations/[integrationSlug]/page.tsx (1)

revalidate (5-5)

apps/web/app/app.dub.co/(dashboard)/[slug]/settings/(basic-layout)/integrations/enabled/page.tsx (1)

revalidate (13-13)

apps/web/app/app.dub.co/(dashboard)/[slug]/settings/(basic-layout)/integrations/page.tsx (1)

revalidate (3-3)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)

GitHub Check: build

🔇 Additional comments (1)

apps/web/app/app.dub.co/(dashboard)/[slug]/settings/(basic-layout)/integrations/[integrationSlug]/manage/page.tsx (1)

7-8: LGTM! Consistent caching strategy for integration management.

Setting revalidate = 0 ensures this integration management page always renders fresh data on each request, which is appropriate for a page where users edit integration settings. This follows the established pattern used in other integration management pages in the same directory structure.

✨ Finishing Touches

📝 Generate Docstrings

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

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Explain this complex logic.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai explain this code block.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and explain its main purpose.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR.
@coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

…ic, remove deprecated functions, and enhance error handling. Introduce new trackLead and trackSale functions for improved event processing.

…nt trackSale function for sale event processing. Refactor sale tracking logic in Singular integration to enhance clarity and maintainability.

…ransformation, add metadata parameter to trackLead and trackSale functions for improved data handling.

Create route.ts

cd1c618

vercel bot had a problem deploying to Preview July 11, 2025 05:04 Failure

devkiran added 3 commits July 11, 2025 11:03

Update route.ts

b007e96

simplify types

15cee78

wip

6c21b2e

vercel bot had a problem deploying to Preview July 11, 2025 10:08 Failure

Add support for Singular event tracking in webhook API

deaceb1

vercel bot had a problem deploying to Preview July 11, 2025 10:26 Failure

Update sales.ts

7d8c4e4

vercel bot had a problem deploying to Preview July 11, 2025 17:42 Failure

Merge branch 'main' into singular

1dd9070

vercel bot had a problem deploying to Preview July 16, 2025 05:32 Failure

Refactor Singular webhook integration: consolidate event tracking log…

8171c45

…ic, remove deprecated functions, and enhance error handling. Introduce new trackLead and trackSale functions for improved event processing.

vercel bot deployed to Preview July 16, 2025 07:45 View deployment

Update error messages for customer external ID validation and impleme…

cda2537

…nt trackSale function for sale event processing. Refactor sale tracking logic in Singular integration to enhance clarity and maintainability.

vercel bot deployed to Preview July 16, 2025 08:02 View deployment

devkiran added 5 commits July 16, 2025 14:09

Enhance Singular event tracking: update revenue type to string with t…

9651276

…ransformation, add metadata parameter to trackLead and trackSale functions for improved data handling.

Implement Singular event authentication and workspace validation

1519a61

Update route.ts

74ace75

rename

279915a

Update create-integration.ts

aedb826

vercel bot deployed to Preview July 16, 2025 09:20 View deployment

pass clickId via cl

2e75c6a

vercel bot deployed to Preview July 16, 2025 09:49 View deployment

steven-tey added 3 commits July 16, 2025 10:23

Merge branch 'main' into singular

18c6f4e

SINGULAR_TOKEN → SINGULAR_WEBHOOK_TOKEN

f678884

fix isSingularLink

7132fb5

vercel bot deployed to Preview July 16, 2025 18:12 View deployment

final changes

69025d4

steven-tey approved these changes Jul 18, 2025

View reviewed changes

vercel bot deployed to Preview July 18, 2025 17:06 View deployment

steven-tey merged commit e29ac47 into main Jul 18, 2025
8 checks passed

steven-tey deleted the singular branch July 18, 2025 17:28

This was referenced Jul 29, 2025

Add conversions stats (new sales only) #2693

Merged

Improve payout success state #2695

Merged

Advanced reward logic upsell updates #2697

Merged

This was referenced Aug 13, 2025

FEAT: iOS Deferred Deep Linking #2746

Merged

Discount code attribution tracking #2620

Merged

This was referenced Aug 21, 2025

Add publishableKey support + /track/**/client #2737

Merged

FEAT: Bounties #2736

Merged

coderabbitai bot mentioned this pull request Sep 8, 2025

Add support for mode="deferred" in /track/lead #2815

Merged

coderabbitai bot mentioned this pull request Sep 17, 2025

Hubspot integration #2839

Merged

This was referenced Oct 2, 2025

Tinybird migration #2924

Merged

Support Stripe sandbox for app testing #2784

Merged

This was referenced Oct 17, 2025

Standardize the Zod usage #2968

Merged

Add workspace_id, domain, and key to dub_clicks_metadata #2996

Merged

This was referenced Nov 9, 2025

Improve support for disabled links #3082

Merged

Refactor to @axiomhq/nextjs #3069

Merged

coderabbitai bot mentioned this pull request Nov 26, 2025

Fraud improvements #3159

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Singular integration #2637

Singular integration #2637

Uh oh!

devkiran commented Jul 11, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

vercel bot commented Jul 11, 2025 •

edited

Loading

Uh oh!

coderabbitai bot commented Jul 11, 2025 •

edited

Loading

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Singular integration #2637

Singular integration #2637

Uh oh!

Conversation

devkiran commented Jul 11, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

vercel bot commented Jul 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

coderabbitai bot commented Jul 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Sequence Diagram(s)

Singular Webhook Event Flow

Lead/Sale Tracking Delegation

Poem

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

devkiran commented Jul 11, 2025 •

edited by coderabbitai bot

Loading

vercel bot commented Jul 11, 2025 •

edited

Loading

coderabbitai bot commented Jul 11, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)