novu-framework-integration

Build code-first notification workflows with @novu/framework. Use when defining workflows in TypeScript (Zod / JSON Schema / Class Validator), composing channel steps (email, SMS, push, chat, in-app) with action steps (delay, digest, custom), exposing Step Controls for non-technical teammates, rendering React/Vue/Svelte Email templates, hosting the Bridge Endpoint inside Next.js, Express, NestJS, Remix, Nuxt, SvelteKit, H3, or AWS Lambda, syncing to Novu Cloud via CLI / GitHub Actions, securing production with HMAC, or implementing translations, hydration, multi-channel orchestration, and LLM-powered notification logic in code.

Quality

81%

Does it follow best practices?

Run evals on this skill

Adds up to 20 points to the overall score

View guide

Securityby

Low

Low-risk findings worth noting

Quality

Content

75%Weight 40%Scale 1-5

Reviews the quality of instructions and guidance provided to agents. Good implementation is clear, handles edge cases, and produces reliable results.

A highly actionable, well-structured reference skill: executable code throughout, clear sequences with local and CI validation, and a complete one-level-deep reference bundle. The main weaknesses are inline duplication of content that lives in the reference files (bridge wrappers, email templates) and the resulting body length.

Suggestions

Keep only the Next.js (App Router) bridge wrapper inline and move the other eight into references/bridge-endpoint.md, replacing them with one-line pointers.

Trim the React Email section to the minimal install-and-render example and defer Vue/Svelte/Remix variants entirely to references/email-templates.md.

Add an explicit verification checkpoint to the Quick Start (e.g. 'trigger a test event in the Studio and confirm the email arrives before syncing to Cloud').

Dimension	Reasoning	Score
Conciseness	The body is dense and table-driven with no padding of concepts Claude already knows, but it could be meaningfully tightened: all nine framework bridge wrappers are inlined in full even though references/bridge-endpoint.md exists for exactly that, and several sections (email templates, translations) duplicate their dedicated reference files. This fits the 'mostly efficient but could be tightened' anchor rather than 'minor instances' (4).	3 / 5
Actionability	Every section gives copy-paste-ready, executable material: a working workflow definition, each step type with real code, bridge mounts for nine frameworks, exact CLI commands with flags in a table, a GitHub Action YAML, and a trigger example. Common cases are covered end-to-end.	5 / 5
Workflow Clarity	The Quick Start is a clear 1–5 sequence with local validation via the Studio ('preview workflows, edit controls, and trigger test events'), the GitOps recipe runs CI sync against the Development environment before Production, and a 14-item Common Pitfalls section covers error recovery (e.g. HMAC failing locally). Only minor validation gaps remain — no explicit 'verify the notification was delivered' checkpoint in the main flow.	4 / 5
Progressive Disclosure	Nine one-level-deep reference files exist, are all well-signaled inline, and are indexed in a final References section with descriptions — good structure. However, content that clearly belongs in those files (the nine inline bridge wrappers, full React Email example) is duplicated in the body rather than split out, which is an organization gap beyond the 'minor' allowed at anchor 5.	4 / 5
	Total	16 / 20 Passed

Description

88%Weight 40%Scale 1-5

Based on the skill's description, can an agent find and select it at the right time? Clear, specific descriptions lead to better discovery.

A strong description: explicit 'what' plus an explicit 'Use when' clause enumerating concrete trigger conditions, named libraries, and channels. Trigger-term coverage and separation from sibling Novu skills are the only minor weaknesses.

Suggestions

Add a couple of natural user-facing synonyms such as 'transactional email', 'in-app messages', or 'alerts' to the trigger clause.

Sharpen the boundary against sibling skills, e.g. 'use for authoring workflows in code — use trigger-notification only to fire existing workflows'.

Dimension	Reasoning	Score
Specificity	The description lists many concrete actions — 'composing channel steps (email, SMS, push, chat, in-app) with action steps (delay, digest, custom)', 'rendering React/Vue/Svelte Email templates', 'hosting the Bridge Endpoint inside Next.js, Express, NestJS, Remix, Nuxt, SvelteKit, H3, or AWS Lambda', 'syncing to Novu Cloud via CLI / GitHub Actions', 'securing production with HMAC' — with comprehensive coverage of the skill's surface.	5 / 5
Completeness	It explicitly answers both what ('Build code-first notification workflows with @novu/framework') and when ('Use when defining workflows in TypeScript (Zod / JSON Schema / Class Validator), composing channel steps... hosting the Bridge Endpoint...') with concrete trigger phrases.	5 / 5
Trigger Term Quality	Good natural keyword coverage: 'notification workflows', all channel names, all host framework names, 'digest', 'delay', 'translations', 'HMAC', 'GitHub Actions'. A few natural user phrasings are missing (e.g. 'transactional email', 'in-app messages', 'alerts'), so it falls short of the comprehensive-with-synonyms anchor.	4 / 5
Distinctiveness Conflict Risk	The @novu/framework code-first niche is distinct and the 'code-first' qualifier separates it from Dashboard workflows, but it sits in a suite of closely related Novu skills (trigger-notification, design-workflow, manage-preferences, inbox-integration) with some trigger overlap (e.g. 'trigger a workflow', 'digest').	4 / 5
	Total	18 / 20 Passed

Validation

81%

Warnings & errors only

Checks the skill against the spec for correct structure and formatting. All validation checks must pass before discovery and implementation can be scored.

Validation — 13 / 16 Passed

Validation for skill structure

Criteria	Description	Result
skill_md_line_count	SKILL.md is long (831 lines); consider splitting into references/ and linking	Warning
frontmatter_unknown_keys	Unknown frontmatter key(s) found; consider removing or moving to metadata	Warning
relative_links	Relative link issues: 5 suspicious	Warning

	Total	13 / 16 Passed

Repository: novuhq/novu
Path: docs/.mintlify/skills/framework-integration/SKILL.md
Commit: 320a0ce

Reviewed: 5 days ago

Table of Contents

Discovery Implementation Validation

Is this your skill?

If you maintain this skill, you can claim it as your own. Once claimed, you can manage eval scenarios, bundle related skills, attach documentation or rules, and ensure cross-agent compatibility.