feat(api-service): Preference webhook subscriber ID fixes NV-7110

[scopsy]

What changed? Why was the change needed?

This PR resolves NV-7110.

The subscriberId has been added to the preference.updated webhook payload. This change allows consumers of the webhook to identify which specific subscriber's preferences were updated, eliminating the need for full synchronizations of all subscriber preferences and reducing load on the user preferences endpoint.

Specifically:

• The WebhookPreferenceDto now includes a subscriberId field.
• The UpdatePreferences use case now includes the subscriberId in the preference.updated webhook payload.
• The SendWebhookMessageCommand payload type was updated to allow primitive values for additional fields, accommodating the subscriberId string.

Screenshots

N/A

---

Linear Issue: NV-7110

 

[cursor]

Cursor Agent can help with this pull request. Just @cursor in comments and I'll start working on changes in this branch.
_{Learn more about Cursor Agents}

[linear]

NV-7110 Include subscriberId in preference updated webhook payload

[netlify]

✅ Deploy Preview for dashboard-v2-novu-staging canceled.

Name	Link
🔨 Latest commit	116697b
🔍 Latest deploy log	https://app.netlify.com/projects/dashboard-v2-novu-staging/deploys/698dadf8e4b4aa00082d9bbf

[coderabbitai]

Walkthrough

This pull request introduces changes to webhook functionality across three files. A new subscriberId field is added to the WebhookPreferenceDto with corresponding Swagger metadata. The UpdatePreferences use case is modified to include subscriberId in the webhook payload. Additionally, the payload property type in SendWebhookMessageCommand is broadened from [key: string]: Record<string, unknown> | undefined; to [key: string]: unknown; to allow more flexible value types.

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title accurately describes the main change: adding subscriberId to the preference webhook payload to resolve NV-7110.
Description check	✅ Passed	The description provides clear context about the changes, explaining why subscriberId was added to the webhook payload and detailing the specific modifications made.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

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

---

No actionable comments were generated in the recent review. 🎉

🧹 Recent nitpick comments

libs/application-generic/src/webhooks/usecases/send-webhook-message/send-webhook-message.command.ts (1)

14-19: Broadening payload index signature to unknown reduces type safety for all webhook events.

The change from Record<string, unknown> | undefined to unknown is the minimal fix to accommodate a string subscriberId, but it also means any future payload field can be any type (e.g., a number, array, or null) without compile-time enforcement.

Consider a narrower union if you want to retain some guardrails:

♻️ Suggested alternative

  `@IsDefined`()
  payload: {
    object: Record<string, unknown>;
    previousObject?: Record<string, unknown>;
-   [key: string]: unknown;
+   [key: string]: Record<string, unknown> | string | undefined;
  };

This keeps the index signature compatible with existing Record<string, unknown> values, the new string value (subscriberId), and optional fields, while still preventing accidentally passing unexpected types like number[] or boolean.

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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