{"docsConfig":{"theme":"luma","$schema":"https://mintlify.com/docs.json","name":"Novu","description":"The open-source notification infrastructure for agents and products. Send, receive, and track notifications across channels.","colors":{"primary":"#0e121b","light":"#FFFFFF","dark":"#FFFFFF"},"logo":{"light":"https://mintcdn.com/novu-c5de82d9/2Q_L4HxwUfLmJjB8/logo/light.svg?fit=max\u0026auto=format\u0026n=2Q_L4HxwUfLmJjB8\u0026q=85\u0026s=23e7050191303b6a0ac4a671dfed8df4","dark":"https://mintcdn.com/novu-c5de82d9/2Q_L4HxwUfLmJjB8/logo/dark.svg?fit=max\u0026auto=format\u0026n=2Q_L4HxwUfLmJjB8\u0026q=85\u0026s=bd7c54f6b7a7b5002ea7b525af3e169c","href":"https://docs.novu.co"},"favicon":"https://mintcdn.com/novu-c5de82d9/ZUl3xXp-4AASlrcI/favicon.svg?fit=max\u0026auto=format\u0026n=ZUl3xXp-4AASlrcI\u0026q=85\u0026s=b53c3afb6a8eaf11aff9db2c5d3f05a1","api":{"openapi":"https://spec.speakeasy.com/novu/novu/json-development-with-code-samples","examples":{"prefill":true}},"background":{},"navbar":{"links":[{"href":"https://novu.co/contact-us","label":"Contact Us"}],"primary":{"type":"button","label":"Get Started","href":"https://dashboard.novu.co/auth/sign-up"}},"footer":{"socials":{"x":"https://x.com/novuhq","github":"https://github.com/novuhq/novu","linkedin":"https://www.linkedin.com/company/novuco"},"links":[{"header":"Comparison","items":[{"label":"Novu vs Courier","href":"https://novu.co/comparison/courier"},{"label":"Novu vs Knock","href":"https://novu.co/comparison/knock"},{"label":"Novu vs MagicBell","href":"https://novu.co/comparison/magicbell"},{"label":"Novu vs SuprSend","href":"https://novu.co/comparison/suprsend"},{"label":"Novu vs In-house","href":"https://novu.co/comparison/building-in-house"}]},{"header":"Resources","items":[{"label":"Contact Support","href":"mailto:support@novu.co"},{"label":"Changelog","href":"https://go.novu.co/changelog?utm_source=docs_footer"},{"label":"Roadmap","href":"https://roadmap.novu.co/roadmap"},{"label":"Contact Sales","href":"https://novu.co/contact-us"},{"label":"Read llms.txt","href":"/llms.txt"}]}]},"seo":{"metatags":{"og:type":"website","twitter:card":"summary_large_image"},"indexing":"all"},"icons":{"library":"lucide"},"integrations":{"gtm":{"tagId":"GTM-KXMC4XP2"},"plausible":{"domain":"docs.novu.co"}},"contextual":{"options":["copy","view","cursor","claude","chatgpt","mcp","add-mcp"],"display":"header"},"thumbnails":{"appearance":"dark","background":"https://mintcdn.com/novu-c5de82d9/vncv7ET97M5-dM6d/images/og/og-image-docs-v2.jpg?fit=max\u0026auto=format\u0026n=vncv7ET97M5-dM6d\u0026q=85\u0026s=26b59f5c597b5b1bea44cbc57cad5e3a","fonts":{"family":"Inter"}},"interaction":{"drilldown":true},"styling":{"latex":false},"navigation":{"global":{"anchors":[]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"novu-c5de82d9","hasAudioNarration":false,"actualSubdomain":"novu-c5de82d9","customDomains":["docs.novu.co"],"gitSource":{"type":"github","owner":"novuhq","repo":"novu","deployBranch":"next","contentDirectory":"docs","isPrivate":false,"mountPath":"","label":""},"chroma":{"collectionId":"313ea6a7-dc00-4182-b4a8-2d4cea7d9086","liveDeploymentHistoryId":"6ae2023c201cdb70a5227b24","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae2023c201cdb70a5227b24"},"feedback":{"thumbs":true,"edits":true,"issues":true,"agentFeedback":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"}},"buildId":"6ae2023c201cdb70a5227b24","clientVersion":"0.0.4021","searchFilterCounts":[{"language":"default","tag":"Notify","count":217},{"language":"default","tag":"API Reference","count":160},{"language":"default","tag":"Resources","count":107},{"language":"default","tag":"Integrate Channels Providers","count":93},{"language":"default","tag":"Guides","count":86},{"language":"default","tag":"Data","count":63},{"language":"default","tag":"Getting Started","count":62},{"language":"default","tag":"Framework","count":52},{"language":"default","tag":"Agent Connect","count":41},{"language":"default","tag":"Sms","count":38}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":true,"enableContextualStarterQuestions":true,"enableAskAiSearchBar":true,"deflection":{"enabled":true,"email":"support@novu.co","showHelpButton":true}},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"per-site-search-delta","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"@media (min-width:1024px){#sidebar-content{width:16rem;min-width:16rem;max-width:16rem}}body:has(#home-content) nav[aria-label=Main] a[aria-current=location]{background:0 0!important;color:rgb(75 85 99)}html.dark body:has(#home-content) nav[aria-label=Main] a[aria-current=location]{color:rgb(156 163 175)}body:has(#home-content) nav[aria-label=Main] a[aria-current=location]:hover{background:rgb(3 7 18/.03)!important;color:rgb(17 24 39)}html.dark body:has(#home-content) nav[aria-label=Main] a[aria-current=location]:hover{background:rgb(255 255 255/.03)!important;color:rgb(229 231 235)}#home-content .hero-cards{margin-top:1.5rem}#home-content .card [data-component-part=card-image]{width:107.5%;max-width:none;margin:-3.75% -3.75% 0}"}],"page":{"pagePath":".mintlify/skills/trigger-notification/references/installation","slug":"/.mintlify/skills/trigger-notification/references/installation","pageMetadata":{"title":null,"description":null,"href":"/.mintlify/skills/trigger-notification/references/installation"},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,p:`p`,pre:`pre`,span:`span`,strong:`strong`,..._provideComponents(),...props.components},{CodeBlock,Heading}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);return _jsxs(_Fragment,{children:[_jsx(Heading,{level:`1`,id:`installation`,children:`Installation`}),`\n`,_jsx(Heading,{level:`2`,id:`node-js-/-typescript`,children:`Node.js / TypeScript`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`5`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`5`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`npm`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` install`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` @novu/api`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`# or`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`pnpm`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` add`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` @novu/api`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`# or`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`yarn`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` add`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` @novu/api`})]}),`\n`]})})}),`\n`,_jsx(Heading,{level:`2`,id:`environment-variables`,children:`Environment Variables`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`1`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`NOVU_SECRET_KEY`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`your-secret-key-here`})]}),`\n`]})})}),`\n`,_jsxs(_components.p,{children:[`Get your API key from `,_jsx(_components.a,{href:`https://dashboard.novu.co/api-keys`,children:`dashboard.novu.co/api-keys`}),`.`]}),`\n`,_jsx(Heading,{level:`2`,id:`initialize-the-sdk`,children:`Initialize the SDK`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`5`,language:`typescript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`typescript`,children:_jsxs(_components.code,{language:`typescript`,numberOfLines:`5`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`import`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` { `}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`Novu`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` } `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`from`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"@novu/api\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`;`})]}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`const`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4FC1FF`},children:` novu`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:` =`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:` new`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:` Novu`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`({`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` secretKey:`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` process`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`.`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`env`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`.`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4FC1FF`},children:`NOVU_SECRET_KEY`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`});`})}),`\n`]})})}),`\n`,_jsx(Heading,{level:`2`,id:`python`,children:`Python`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`1`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`pip`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` install`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` novu-py`})]}),`\n`]})})}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`6`,language:`python`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`python`,children:_jsxs(_components.code,{language:`python`,numberOfLines:`6`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`import`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` novu_py`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`from`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` novu_py `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`import`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` Novu`})]}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`with`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` Novu(`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:` secret_key`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"YOUR_SECRET_KEY_HERE\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`) `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`as`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` novu:`})]}),`\n`]})})}),`\n`,_jsx(Heading,{level:`2`,id:`curl`,children:`cURL`}),`\n`,_jsxs(_components.p,{children:[`All API requests require the `,_jsx(_components.code,{children:`Authorization`}),` header:`]}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`8`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`8`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`curl`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -X`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` POST`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` https://api.novu.co/v1/events/trigger`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Authorization: ApiKey YOUR_SECRET_KEY\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Content-Type: application/json\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -d`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` '{`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"name\": \"workflow-id\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"to\": \"subscriber-id\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"payload\": {}`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` }'`})}),`\n`]})})}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Note:`}),` In the REST API, the trigger field is called `,_jsx(_components.code,{children:`name`}),` (not `,_jsx(_components.code,{children:`workflowId`}),`). The SDK maps `,_jsx(_components.code,{children:`workflowId`}),` to `,_jsx(_components.code,{children:`name`}),` automatically.`]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":null,"description":null,"href":"/.mintlify/skills/trigger-notification/references/installation"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Installation","slug":"installation","depth":1,"children":[]},{"title":"Node.js / TypeScript","slug":"node-js-/-typescript","depth":2,"children":[]},{"title":"Environment Variables","slug":"environment-variables","depth":2,"children":[]},{"title":"Initialize the SDK","slug":"initialize-the-sdk","depth":2,"children":[]},{"title":"Python","slug":"python","depth":2,"children":[]},{"title":"cURL","slug":"curl","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"subdomain":"novu-c5de82d9","siteName":"Novu","title":"Installation - Novu","contextualStarterQuestions":[{"_id":"6adb11773feb0cfe29625e69","deploymentId":"6a3b890b89d2acbacf3fa68a","questionText":"How do I initialize Novu?","status":"active","generatedBy":"contextual","path":".mintlify/skills/trigger-notification/references/installation","createdAt":"2026-10-23T07:49:11.358Z","updatedAt":"2026-10-23T07:49:11.358Z","__v":0},{"_id":"6adb11773feb0cfe29625e68","deploymentId":"6a3b890b89d2acbacf3fa68a","questionText":"Where do I get my API key?","status":"active","generatedBy":"contextual","path":".mintlify/skills/trigger-notification/references/installation","createdAt":"2026-10-23T07:49:11.358Z","updatedAt":"2026-10-23T07:49:11.358Z","__v":0},{"_id":"6adb11773feb0cfe29625e67","deploymentId":"6a3b890b89d2acbacf3fa68a","questionText":"How do I install the SDK?","status":"active","generatedBy":"contextual","path":".mintlify/skills/trigger-notification/references/installation","createdAt":"2026-10-23T07:49:11.358Z","updatedAt":"2026-10-23T07:49:11.358Z","__v":0}],"navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-23T07:49:02.391Z","originalFileLocation":".mintlify/skills/trigger-notification/references/installation.md"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"application-name\" content=\"Novu\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/novu-c5de82d9/hif-BqO_gbG8zfWr/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/novu-c5de82d9/hif-BqO_gbG8zfWr/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/novu-c5de82d9/hif-BqO_gbG8zfWr/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/novu-c5de82d9/hif-BqO_gbG8zfWr/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/novu-c5de82d9/hif-BqO_gbG8zfWr/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/novu-c5de82d9/hif-BqO_gbG8zfWr/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/novu-c5de82d9/hif-BqO_gbG8zfWr/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/novu-c5de82d9/hif-BqO_gbG8zfWr/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/novu-c5de82d9/hif-BqO_gbG8zfWr/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Installation - Novu\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Novu\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.novu.co/.mintlify/skills/trigger-notification/references/installation\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://novu-c5de82d9.mintlify.app/_mintlify/api/og/v2?division=Documentation\u0026amp;title=Installation\u0026amp;theme=1ee19fc55ed421ff750b0681\u0026amp;signature=5a8964dc5c119f5caa15e8bb956a7e95238caee118da70eedf2610fabd20bbb2\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Installation - Novu\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://novu-c5de82d9.mintlify.app/_mintlify/api/og/v2?division=Documentation\u0026amp;title=Installation\u0026amp;theme=1ee19fc55ed421ff750b0681\u0026amp;signature=5a8964dc5c119f5caa15e8bb956a7e95238caee118da70eedf2610fabd20bbb2\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/novu-c5de82d9/hif-BqO_gbG8zfWr/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Novu\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0e121b\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.novu.co/.mintlify/skills/trigger-notification/references/installation\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/.mintlify/skills/trigger-notification/references/installation.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.novu.co/#organization\",\"name\":\"Novu\",\"url\":\"https://docs.novu.co\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/novu-c5de82d9/2Q_L4HxwUfLmJjB8/logo/light.svg?fit=max\u0026auto=format\u0026n=2Q_L4HxwUfLmJjB8\u0026q=85\u0026s=23e7050191303b6a0ac4a671dfed8df4\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.novu.co#website\",\"name\":\"Novu\",\"url\":\"https://docs.novu.co\",\"publisher\":{\"@id\":\"https://docs.novu.co/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.novu.co/.mintlify/skills/trigger-notification/references/installation#webpage\",\"url\":\"https://docs.novu.co/.mintlify/skills/trigger-notification/references/installation\",\"name\":\"Installation\",\"dateModified\":\"2026-10-23T07:49:02.391Z\",\"isPartOf\":{\"@id\":\"https://docs.novu.co#website\"}},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.novu.co/.mintlify/skills/trigger-notification/references/installation#article\",\"headline\":\"Installation\",\"name\":\"Installation\",\"url\":\"https://docs.novu.co/.mintlify/skills/trigger-notification/references/installation\",\"mainEntityOfPage\":{\"@id\":\"https://docs.novu.co/.mintlify/skills/trigger-notification/references/installation#webpage\"},\"dateModified\":\"2026-10-23T07:49:02.391Z\",\"publisher\":{\"@id\":\"https://docs.novu.co/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.novu.co#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Novu\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Novu","nav":{"global":{"anchors":[]},"tabs":[{"tab":"Notify","groups":[{"group":"Getting Started","boost":3,"pages":[{"title":"Novu Platform - Open-Source Notification Infrastructure","sidebarTitle":"Overview","href":"/platform"},{"title":"What is Novu?","href":"/platform/what-is-novu"},{"title":"How Novu Works - Architecture and Notification Flow","sidebarTitle":"How Novu Works","href":"/platform/how-novu-works"},{"group":"Novu for your team","pages":[{"title":"Novu for Developers and Engineers","sidebarTitle":"Developers","href":"/platform/novu-for/developers"},{"title":"Novu for Product Teams","sidebarTitle":"Product","href":"/platform/novu-for/product"}]},{"group":"Core Concepts","pages":[{"title":"Notification event","href":"/platform/concepts/notification-event"},{"title":"How do workflows work in Novu?","sidebarTitle":"Workflows","href":"/platform/concepts/workflows"},{"title":"How do subscribers work in Novu?","sidebarTitle":"Subscribers","href":"/platform/concepts/subscribers"},{"title":"Topics","href":"/platform/concepts/topics"},{"title":"Integrations","href":"/platform/concepts/integrations"},{"title":"Trigger","href":"/platform/concepts/trigger"},{"title":"Preferences","href":"/platform/concepts/preferences"},{"title":"How do contexts work in Novu?","sidebarTitle":"Contexts","href":"/platform/concepts/contexts"},{"title":"Multi-tenancy","href":"/platform/concepts/tenants"}]},{"group":"Quickstart","pages":[{"title":"Next.js In-App Notifications Quickstart - Novu Inbox","sidebarTitle":"Next.js","href":"/platform/quickstart/nextjs"},{"title":"React In-App Notifications Quickstart - Novu Inbox","sidebarTitle":"React","href":"/platform/quickstart/react"},{"title":"Remix In-App Notifications Quickstart - Novu Inbox","sidebarTitle":"Remix","href":"/platform/quickstart/remix"},{"title":"Angular In-App Notifications Quickstart - Novu Inbox","sidebarTitle":"Angular","href":"/platform/quickstart/angular"},{"title":"Vue In-App Notifications Quickstart - Novu Inbox","sidebarTitle":"Vue","href":"/platform/quickstart/vue"},{"title":"Nuxt In-App Notifications Quickstart - Novu Inbox","sidebarTitle":"Nuxt","href":"/platform/quickstart/nuxt"},{"title":"Vanilla JS In-App Notifications Quickstart - Novu Inbox","sidebarTitle":"Vanilla JS","href":"/platform/quickstart/vanilla-js"}]}]},{"group":"Integrate \u003cInbox />","icon":"inbox","pages":[{"title":"Novu Inbox - In-App Notification Component for React","sidebarTitle":"Introduction to Inbox","href":"/platform/inbox"},{"title":"Set up the Inbox","href":"/platform/inbox/setup-inbox"},{"group":"Features","pages":[{"title":"Snooze","href":"/platform/inbox/features/snooze"},{"title":"Schedule","href":"/platform/inbox/features/schedule"}]},{"group":"Customize and Configure","pages":[{"title":"Styling and Theming","href":"/platform/inbox/configuration/styling"},{"title":"Tabs","href":"/platform/inbox/configuration/tabs"},{"title":"Preferences","href":"/platform/inbox/configuration/preferences"},{"title":"Data Object","href":"/platform/inbox/configuration/data-object"},{"title":"Inbox with Context","href":"/platform/inbox/configuration/inbox-with-context"},{"title":"Icons","href":"/platform/inbox/configuration/icons"}]},{"group":"Advanced Customization","pages":[{"title":"Customize Bell Icon","href":"/platform/inbox/advanced-customization/customize-bell"},{"title":"Customize Popover","href":"/platform/inbox/advanced-customization/customize-popover"},{"title":"Customize Notification Items","href":"/platform/inbox/advanced-customization/customize-notification-items"},{"title":"Conditional Display","href":"/platform/inbox/advanced-customization/conditional-display"},{"title":"HTML in Notifications","href":"/platform/inbox/advanced-customization/html-in-notifications"},{"title":"Notification Click Behavior","href":"/platform/inbox/advanced-customization/notification-click-behavior"}]},{"group":"Advanced Features","pages":[{"title":"Localization","href":"/platform/inbox/advanced-features/localization"},{"title":"Multi-tenancy","href":"/platform/inbox/advanced-features/multi-tenancy"}]},{"title":"Headless Mode","href":"/platform/inbox/headless-mode"},{"title":"Prepare for Production","href":"/platform/inbox/prepare-for-production"},{"title":"Migrate to the New Inbox","href":"/platform/inbox/migration-guide"}]},{"group":"Integrate \u003cSubscription />","icon":"bell-ring","pages":[{"title":"Introduction","href":"/platform/subscription"},{"title":"Setup the Subscription","href":"/platform/subscription/quickstart"},{"title":"Manage topic subscriptions","href":"/platform/subscription/manage-topic-subscriptions"},{"title":"Customize and configure","href":"/platform/subscription/customize-and-configure"},{"title":"Headless hooks","href":"/platform/subscription/headless-hooks"}]},{"group":"Build a Workflow","icon":"git-branch","pages":[{"title":"Notification Workflows in Novu","sidebarTitle":"Workflows","href":"/platform/workflow"},{"title":"Create a Workflow","href":"/platform/workflow/create-a-workflow"},{"title":"Configure Workflow","href":"/platform/workflow/configure-workflow"},{"group":"Add And Configure Steps","root":{"title":"Add and Configure Steps","href":"/platform/workflow/add-and-configure-steps"},"pages":[{"group":"Configure Action Steps","pages":[{"title":"Delay Step","href":"/platform/workflow/add-and-configure-steps/configure-action-steps/delay"},{"title":"Digest Step","href":"/platform/workflow/add-and-configure-steps/configure-action-steps/digest"},{"title":"Throttle Step","href":"/platform/workflow/add-and-configure-steps/configure-action-steps/throttle"},{"title":"HTTP Step","href":"/platform/workflow/add-and-configure-steps/configure-action-steps/http-step"}]},{"title":"Step Conditions","href":"/platform/workflow/add-and-configure-steps/step-conditions"},{"title":"Code Steps","href":"/platform/workflow/add-and-configure-steps/code-steps"}]},{"group":"Add Notification Content","pages":[{"title":"Channels Template Editors","href":"/platform/workflow/add-notification-content/channels-template-editors"},{"title":"Personalize Content","href":"/platform/workflow/add-notification-content/personalize-content"}]},{"title":"Trigger Workflow","href":"/platform/workflow/trigger-workflow"},{"title":"Monitor and Debug Workflow","href":"/platform/workflow/monitor-and-debug-workflow"},{"title":"Usage","href":"/platform/workflow/usage"},{"group":"Advanced Features","pages":[{"title":"Translations","href":"/platform/workflow/advanced-features/translations"},{"group":"Contexts","pages":[{"title":"Manage contexts","href":"/platform/workflow/advanced-features/contexts/manage-contexts"},{"title":"Applying context","href":"/platform/workflow/advanced-features/contexts/contexts-in-workflows"}]}]}]},{"group":"Integrate Channels Providers","icon":"plug-zap","pages":[{"title":"Notification Channel Providers and Integrations","sidebarTitle":"Overview","href":"/platform/integrations"},{"title":"Integration conditions","href":"/platform/integrations/integration-conditions"},{"title":"Demo Integrations","href":"/platform/integrations/demo-integration"},{"group":"Chat","root":{"title":"Chat","href":"/platform/integrations/chat"},"pages":[{"title":"How to Write Chat Templates in Novu","sidebarTitle":"Writing Chat Template","href":"/platform/integrations/chat/writing-chat-template"},{"title":"Discord Chat Integration with Novu","sidebarTitle":"Discord","href":"/platform/integrations/chat/discord"},{"title":"Google Chat Integration with Novu","sidebarTitle":"Google Chat","href":"/platform/integrations/chat/google-chat"},{"title":"LINE","href":"/platform/integrations/chat/line"},{"title":"Mattermost Chat Integration with Novu","sidebarTitle":"Mattermost","href":"/platform/integrations/chat/mattermost"},{"group":"MS Teams","pages":[{"title":"MS Teams Chat Integration with Novu","sidebarTitle":"MS Teams","href":"/platform/integrations/chat/ms-teams"},{"title":"Set up the Microsoft Teams bot","sidebarTitle":"Teams Azure setup","href":"/platform/integrations/chat/ms-teams-azure-setup"},{"title":"Connect Microsoft Teams tenants and destinations","sidebarTitle":"Teams tenant connect","href":"/platform/integrations/chat/ms-teams-connect"},{"title":"Microsoft Teams Workflows (webhook)","sidebarTitle":"Teams workflows","href":"/platform/integrations/chat/ms-teams-workflows"}]},{"title":"Slack Chat Integration with Novu","sidebarTitle":"Slack","href":"/platform/integrations/chat/slack"},{"title":"Webex Messaging Chat Integration with Novu","sidebarTitle":"Webex Messaging","href":"/platform/integrations/chat/webex-messaging"},{"title":"Telegram","href":"/platform/integrations/chat/telegram"},{"title":"WhatsApp Business Chat Integration with Novu","sidebarTitle":"WhatsApp Business","href":"/platform/integrations/chat/whats-app"},{"title":"Zulip Chat Integration with Novu","sidebarTitle":"Zulip","href":"/platform/integrations/chat/zulip"}]},{"group":"Email","root":{"title":"E-mail","href":"/platform/integrations/email"},"pages":[{"title":"SendGrid Email Integration with Novu","sidebarTitle":"SendGrid","href":"/platform/integrations/email/sendgrid"},{"title":"Amazon SES Email Integration with Novu","sidebarTitle":"Amazon SES","href":"/platform/integrations/email/amazon-ses"},{"title":"Resend Email Integration with Novu","sidebarTitle":"Resend","href":"/platform/integrations/email/resend"},{"title":"Postmark Email Integration with Novu","sidebarTitle":"Postmark","href":"/platform/integrations/email/postmark"},{"title":"Brevo Email Integration with Novu","sidebarTitle":"Brevo","href":"/platform/integrations/email/brevo"},{"title":"Sinch Mailgun Email Integration with Novu","sidebarTitle":"Sinch Mailgun","href":"/platform/integrations/email/mailgun"},{"title":"Mailjet Email Integration with Novu","sidebarTitle":"Mailjet","href":"/platform/integrations/email/mailjet"},{"title":"Sparkpost Email Integration with Novu","sidebarTitle":"Sparkpost","href":"/platform/integrations/email/sparkpost"},{"title":"Mandrill Email Integration with Novu","sidebarTitle":"Mandrill","href":"/platform/integrations/email/mandrill"},{"title":"Outlook 365 Email Integration with Novu","sidebarTitle":"Outlook 365","href":"/platform/integrations/email/outlook365"},{"title":"Infobip Email Integration with Novu","sidebarTitle":"Infobip","href":"/platform/integrations/email/infobip"},{"title":"Braze Email Integration with Novu","sidebarTitle":"Braze","href":"/platform/integrations/email/braze"},{"title":"MailerSend Email Integration with Novu","sidebarTitle":"MailerSend","href":"/platform/integrations/email/mailersend"},{"title":"Mailtrap Email Integration with Novu","sidebarTitle":"Mailtrap","href":"/platform/integrations/email/mailtrap"},{"title":"Netcore Email Integration with Novu","sidebarTitle":"Netcore","href":"/platform/integrations/email/netcore"},{"title":"Plunk Email Integration with Novu","sidebarTitle":"Plunk","href":"/platform/integrations/email/plunk"},{"title":"Anypost","href":"/platform/integrations/email/anypost"},{"title":"Email Webhook Email Integration with Novu","sidebarTitle":"Email Webhook","href":"/platform/integrations/email/webhook"},{"title":"Custom SMTP Email Integration with Novu","sidebarTitle":"Custom SMTP","href":"/platform/integrations/email/custom-smtp"},{"title":"How to Write Email Templates in Novu","sidebarTitle":"Writing Email Template","href":"/platform/integrations/email/writing-email-template"},{"group":"Activity Tracking","pages":[{"group":"Manual Configuration","pages":[{"title":"Amazon SES","href":"/platform/integrations/email/activity-tracking/manual-configuration/ses"},{"title":"Mailgun","href":"/platform/integrations/email/activity-tracking/manual-configuration/mailgun"},{"title":"Resend","href":"/platform/integrations/email/activity-tracking/manual-configuration/resend"},{"title":"SendGrid","href":"/platform/integrations/email/activity-tracking/manual-configuration/sendgrid"},{"title":"Anypost","href":"/platform/integrations/email/activity-tracking/manual-configuration/anypost"}]}]}]},{"group":"Push","root":{"title":"Push","href":"/platform/integrations/push"},"pages":[{"title":"FCM Push Integration with Novu","sidebarTitle":"FCM","href":"/platform/integrations/push/fcm"},{"title":"Expo Push Push Integration with Novu","sidebarTitle":"Expo Push","href":"/platform/integrations/push/expo-push"},{"title":"APNS Push Integration with Novu","sidebarTitle":"APNS","href":"/platform/integrations/push/apns"},{"title":"OneSignal Push Integration with Novu","sidebarTitle":"OneSignal","href":"/platform/integrations/push/onesignal"},{"title":"Push Webhook Push Integration with Novu","sidebarTitle":"Push Webhook","href":"/platform/integrations/push/push-webhook"},{"title":"Pusher Beams Push Integration with Novu","sidebarTitle":"Pusher Beams","href":"/platform/integrations/push/pusher-beams"},{"title":"Pushpad Push Integration with Novu","sidebarTitle":"Pushpad","href":"/platform/integrations/push/pushpad"},{"title":"Activity Tracking","href":"/platform/integrations/push/push-activity-tracking"}]},{"group":"Sms","root":{"title":"SMS","href":"/platform/integrations/sms"},"pages":[{"title":"Twilio SMS Integration with Novu","sidebarTitle":"Twilio","href":"/platform/integrations/sms/twilio"},{"title":"AWS SNS SMS Integration with Novu","sidebarTitle":"AWS SNS","href":"/platform/integrations/sms/aws-sns"},{"title":"Infobip SMS Integration with Novu","sidebarTitle":"Infobip - SMS","href":"/platform/integrations/sms/infobip"},{"title":"Sinch SMS Integration with Novu","sidebarTitle":"Sinch","href":"/platform/integrations/sms/sinch"},{"title":"Nexmo SMS Integration with Novu","sidebarTitle":"Nexmo","href":"/platform/integrations/sms/nexmo"},{"title":"MessageBird SMS Integration with Novu","sidebarTitle":"MessageBird","href":"/platform/integrations/sms/messagebird"},{"title":"Telnyx SMS Integration with Novu","sidebarTitle":"Telnyx","href":"/platform/integrations/sms/telnyx"},{"title":"CM.com SMS Integration with Novu","sidebarTitle":"CM.com","href":"/platform/integrations/sms/cm-com"},{"title":"Plivo SMS Integration with Novu","sidebarTitle":"Plivo","href":"/platform/integrations/sms/plivo"},{"title":"Bandwidth SMS Integration with Novu","sidebarTitle":"Bandwidth","href":"/platform/integrations/sms/bandwidth"},{"title":"RingCentral SMS Integration with Novu","sidebarTitle":"RingCentral","href":"/platform/integrations/sms/ring-central"},{"title":"Azure SMS SMS Integration with Novu","sidebarTitle":"Azure SMS","href":"/platform/integrations/sms/azure"},{"title":"Clicksend SMS Integration with Novu","sidebarTitle":"Clicksend","href":"/platform/integrations/sms/clicksend"},{"title":"Brevo SMS Integration with Novu","sidebarTitle":"Brevo - SMS","href":"/platform/integrations/sms/brevo"},{"title":"Clickatell SMS Integration with Novu","sidebarTitle":"Clickatell","href":"/platform/integrations/sms/clickatell"},{"title":"BulkSMS SMS Integration with Novu","sidebarTitle":"BulkSMS","href":"/platform/integrations/sms/bulk-sms"},{"title":"SMS77 SMS Integration with Novu","sidebarTitle":"SMS77","href":"/platform/integrations/sms/sms77"},{"title":"Africa's Talking SMS Integration with Novu","sidebarTitle":"Africa's Talking","href":"/platform/integrations/sms/africas-talking"},{"title":"Unifonic SMS Integration with Novu","sidebarTitle":"Unifonic","href":"/platform/integrations/sms/unifonic"},{"title":"Gupshup SMS Integration with Novu","sidebarTitle":"Gupshup","href":"/platform/integrations/sms/gupshup"},{"title":"Termii SMS Integration with Novu","sidebarTitle":"Termii","href":"/platform/integrations/sms/termii"},{"title":"Kudosity SMS Integration with Novu","sidebarTitle":"Kudosity","href":"/platform/integrations/sms/kudosity"},{"title":"Sendchamp SMS Integration with Novu","sidebarTitle":"Sendchamp","href":"/platform/integrations/sms/sendchamp"},{"title":"SimpleTexting SMS Integration with Novu","sidebarTitle":"SimpleTexting","href":"/platform/integrations/sms/simpletexting"},{"title":"46elks SMS Integration with Novu","sidebarTitle":"46elks","href":"/platform/integrations/sms/46elks"},{"title":"Firetext SMS Integration with Novu","sidebarTitle":"Firetext","href":"/platform/integrations/sms/firetext"},{"title":"SMS Central SMS Integration with Novu","sidebarTitle":"SMS Central","href":"/platform/integrations/sms/sms-central"},{"title":"Kannel SMS Integration with Novu","sidebarTitle":"Kannel","href":"/platform/integrations/sms/kannel"},{"title":"Maqsam SMS Integration with Novu","sidebarTitle":"Maqsam","href":"/platform/integrations/sms/maqsam"},{"title":"Mobishastra SMS Integration with Novu","sidebarTitle":"Mobishastra","href":"/platform/integrations/sms/mobishastra"},{"title":"Afro Message SMS Integration with Novu","sidebarTitle":"Afro Message","href":"/platform/integrations/sms/afro-message"},{"title":"smsmode SMS Integration with Novu","sidebarTitle":"smsmode","href":"/platform/integrations/sms/smsmode"},{"title":"iSend SMS Integration with Novu","sidebarTitle":"iSend SMS","href":"/platform/integrations/sms/isend-sms"},{"title":"iSendPro SMS Integration with Novu","sidebarTitle":"iSendPro","href":"/platform/integrations/sms/isendpro"},{"title":"iMedia SMS Integration with Novu","sidebarTitle":"iMedia","href":"/platform/integrations/sms/imedia"},{"title":"Eazy SMS Integration with Novu","sidebarTitle":"Eazy","href":"/platform/integrations/sms/eazy"},{"title":"Ruach SMS Integration with Novu","sidebarTitle":"Ruach SMS","href":"/platform/integrations/sms/ruach-sms"},{"title":"SMS Webhook SMS Integration with Novu","sidebarTitle":"SMS Webhook","href":"/platform/integrations/sms/sms-webhook"}]},{"group":"Tool","pages":[{"title":"PagerDuty Tool Integration with Novu","sidebarTitle":"PagerDuty","href":"/platform/integrations/tool/pagerduty"},{"title":"Opsgenie Tool Integration with Novu","sidebarTitle":"Opsgenie","href":"/platform/integrations/tool/opsgenie"},{"title":"Grafana Tool Integration with Novu","sidebarTitle":"Grafana","href":"/platform/integrations/tool/grafana"},{"title":"Tool Webhook Tool Integration with Novu","sidebarTitle":"Tool Webhook","href":"/platform/integrations/tool/webhook"}]},{"title":"Trigger Overrides","href":"/platform/integrations/trigger-overrides"}]},{"group":"SDKs","icon":"code","pages":[{"title":"Novu SDKs for server, web, and mobile apps","sidebarTitle":"Overview","href":"/platform/sdks"},{"group":"@novu/react","pages":[{"title":"@novu/react","href":"/platform/sdks/react"},{"group":"Hooks","pages":[{"title":"NovuProvider","href":"/platform/sdks/react/hooks/novu-provider"},{"title":"Subscription","href":"/platform/sdks/react/hooks/subscription"},{"title":"useWebChat","tag":"Beta","href":"/platform/sdks/react/hooks/use-web-chat"},{"title":"useCounts","href":"/platform/sdks/react/hooks/use-counts"},{"title":"useNotifications","href":"/platform/sdks/react/hooks/use-notifications"},{"title":"useNovu","href":"/platform/sdks/react/hooks/use-novu"},{"title":"usePreferences","href":"/platform/sdks/react/hooks/use-preferences"},{"title":"useSchedule","href":"/platform/sdks/react/hooks/use-schedule"}]},{"title":"Changelog","href":"/platform/sdks/react/changelog"}]},{"title":"@novu/js","href":"/platform/sdks/javascript"},{"group":"@novu/react-native","root":{"title":"Quickstart","href":"/platform/sdks/react-native"},"pages":[{"title":"Quickstart","href":"/platform/sdks/react-native"},{"group":"Hooks","pages":[{"title":"NovuProvider","href":"/platform/sdks/react-native/hooks/novu-provider"},{"title":"useNovu","href":"/platform/sdks/react-native/hooks/use-novu"},{"title":"useNotifications","href":"/platform/sdks/react-native/hooks/use-notifications"},{"title":"useCounts","href":"/platform/sdks/react-native/hooks/use-counts"},{"title":"usePreferences","href":"/platform/sdks/react-native/hooks/use-preferences"},{"title":"useSchedule","href":"/platform/sdks/react-native/hooks/use-schedule"}]}]},{"group":"Server-Side","root":{"title":"Server Side","href":"/platform/sdks/server"},"pages":[{"title":"Typescript","href":"/platform/sdks/server/typescript"},{"title":"Python","href":"/platform/sdks/server/python"},{"title":"Go SDK","href":"/platform/sdks/server/go"},{"title":"PHP SDK","href":"/platform/sdks/server/php"},{"title":".NET","href":"/platform/sdks/server/dotnet"},{"title":"Java","href":"/platform/sdks/server/java"},{"title":"Kotlin","href":"/platform/sdks/server/kotlin"},{"title":"Laravel","href":"/platform/sdks/server/laravel"},{"title":"Ruby","href":"/platform/sdks/server/ruby"}]}]},{"group":"Developer","icon":"terminal","pages":[{"title":"API keys","href":"/platform/developer/api-keys"},{"title":"Environments","href":"/platform/developer/environments"},{"title":"Environment Variables","href":"/platform/developer/environment-variables"},{"title":"Limits","href":"/platform/developer/limits"},{"title":"Delivery Retry Policy for Channels, Providers, and Steps","sidebarTitle":"Retry policy","href":"/platform/developer/delivery-retries"},{"group":"Inbound email","pages":[{"title":"Inbound Email","sidebarTitle":"Overview","href":"/platform/inbound-email/overview"}]},{"group":"Webhooks","pages":[{"title":"Webhooks","href":"/platform/developer/webhooks/webhooks"},{"title":"Event types","href":"/platform/developer/webhooks/event-types"},{"title":"Webhook connectors","href":"/platform/developer/webhooks/connectors"}]}]},{"group":"Account","icon":"building-2","pages":[{"title":"Authentication","href":"/platform/account/authentication"},{"title":"Organizations","href":"/platform/account/organizations"},{"title":"Roles and permissions","href":"/platform/account/roles-and-permissions"},{"title":"Team members","href":"/platform/account/manage-members"},{"title":"Billing","href":"/platform/account/billing"},{"title":"SAML SSO \u0026 SCIM","href":"/platform/account/sso"},{"group":"SSO providers","pages":[{"title":"Okta Workforce SSO","sidebarTitle":"Okta Workforce","href":"/platform/account/sso/okta"},{"title":"Microsoft Entra ID SSO","sidebarTitle":"Microsoft Entra ID","href":"/platform/account/sso/microsoft-entra"},{"title":"Google Workspace SSO","sidebarTitle":"Google Workspace","href":"/platform/account/sso/google-workspace"},{"title":"Custom SAML SSO","sidebarTitle":"Custom SAML","href":"/platform/account/sso/custom-saml"},{"title":"OpenID Connect SSO","sidebarTitle":"OpenID Connect","href":"/platform/account/sso/oidc"}]},{"group":"Directory sync","pages":[{"title":"Directory sync","href":"/platform/account/directory-sync"},{"title":"Okta directory sync","sidebarTitle":"Okta","href":"/platform/account/directory-sync/okta"},{"title":"Microsoft Entra ID directory sync","sidebarTitle":"Microsoft Entra ID","href":"/platform/account/directory-sync/microsoft-entra"},{"title":"Google Workspace directory sync","sidebarTitle":"Google Workspace","href":"/platform/account/directory-sync/google-workspace"},{"title":"Custom SCIM directory sync","sidebarTitle":"Custom SCIM","href":"/platform/account/directory-sync/custom-scim"}]}]},{"group":"Build with AI","icon":"sparkles","pages":[{"title":"Novu MCP Server","href":"/platform/build-with-ai/mcp"},{"title":"Agent Skills","href":"/platform/build-with-ai/skills"},{"title":"Agent Toolkit","href":"/platform/build-with-ai/agent-toolkit"}]},{"group":"Additional Resources","icon":"book-open","pages":[{"title":"Glossary","href":"/platform/additional-resources/glossary"},{"title":"Common errors","href":"/platform/additional-resources/errors"},{"title":"Security and Compliance","href":"/platform/additional-resources/security"},{"title":"v0.x Documentation","href":"/platform/additional-resources/legacy-documentation"}]}]},{"tab":"Agent Connect","groups":[{"group":"Getting Started","boost":3,"pages":[{"title":"Novu Connect - Agent Communication Infrastructure (ACI)","sidebarTitle":"Overview","href":"/agents"},{"title":"What is ACI?","href":"/agents/get-started/what-is-aci"},{"title":"Mental model","href":"/agents/get-started/mental-model"},{"title":"Agents and providers","href":"/agents/get-started/agents-and-providers"},{"title":"Workflow-assigned agents","sidebarTitle":"Workflow-assigned agents","href":"/agents/workflow-agents"},{"group":"Quickstart","pages":[{"title":"Connect AI SDK to Slack","sidebarTitle":"Connect AI SDK","href":"/agents/get-started/ai-sdk"},{"title":"Connect LangChain to Slack","sidebarTitle":"Connect LangChain","href":"/agents/get-started/langchain"},{"title":"Connect Mastra to Slack","sidebarTitle":"Connect Mastra","href":"/agents/get-started/mastra"},{"title":"Connect Claude managed agent","sidebarTitle":"Claude Managed","href":"/agents/get-started/claude-managed"},{"title":"Connect AWS Claude managed agent","sidebarTitle":"AWS Claude Managed","href":"/agents/get-started/aws-claude"}]}]},{"group":"Channels","icon":"messages-square","pages":[{"title":"Overview","sidebarTitle":"Overview","href":"/agents/channels/overview"},{"title":"Slack","sidebarTitle":"Slack","href":"/agents/channels/slack"},{"title":"Microsoft Teams","sidebarTitle":"Microsoft Teams","href":"/agents/channels/microsoft-teams"},{"title":"WhatsApp","sidebarTitle":"WhatsApp","href":"/agents/channels/whatsapp"},{"title":"Telegram","sidebarTitle":"Telegram","href":"/agents/channels/telegram"},{"title":"Email","sidebarTitle":"Email","href":"/agents/channels/email"},{"group":"Web Chat","root":{"title":"Web Chat","sidebarTitle":"Web Chat","href":"/agents/channels/web-chat"},"tag":"Beta","pages":[{"title":"Messages","sidebarTitle":"Messages","href":"/agents/channels/web-chat/messages"},{"title":"Tools","sidebarTitle":"Tools","href":"/agents/channels/web-chat/tools"},{"title":"Generative UI","sidebarTitle":"Generative UI","href":"/agents/channels/web-chat/generative-ui"},{"title":"Conversations","sidebarTitle":"Conversations","href":"/agents/channels/web-chat/conversations"},{"group":"Recipes","pages":[{"title":"Use assistant-ui","sidebarTitle":"assistant-ui","href":"/agents/channels/web-chat/recipes/assistant-ui"}]},{"title":"Security","sidebarTitle":"Security","href":"/agents/channels/web-chat/security"}]}]},{"group":"Custom Code Agent","icon":"code","pages":[{"title":"Concepts","href":"/agents/custom-code-agent/concepts"},{"title":"Connecting your app","href":"/agents/custom-code-agent/connecting-your-app"},{"group":"Frameworks","pages":[{"title":"AI SDK reference","sidebarTitle":"AI SDK","href":"/agents/custom-code-agent/frameworks/ai-sdk"},{"title":"LangChain reference","sidebarTitle":"LangChain","href":"/agents/custom-code-agent/frameworks/langchain"},{"title":"Other frameworks reference","sidebarTitle":"Other","href":"/agents/custom-code-agent/frameworks/other"}]},{"group":"Building blocks","pages":[{"title":"Handlers and context","href":"/agents/custom-code-agent/building-blocks/handle-events"},{"title":"Reply","href":"/agents/custom-code-agent/building-blocks/reply"},{"title":"Emit custom events","sidebarTitle":"Emit","href":"/agents/custom-code-agent/building-blocks/emit"},{"title":"Typing indicator","href":"/agents/custom-code-agent/building-blocks/typing-indicator"},{"title":"Edit sent messages","href":"/agents/custom-code-agent/building-blocks/edit-sent-messages"},{"title":"Signals","href":"/agents/custom-code-agent/building-blocks/signals"},{"title":"Tool approval","href":"/agents/custom-code-agent/building-blocks/tool-approval"}]},{"title":"Connect Components","href":"/agents/custom-code-agent/connect-components"},{"title":"Going to production","href":"/agents/custom-code-agent/going-to-production"}]},{"group":"Managed Agent","icon":"bot","pages":[{"title":"Managed Agent Overview - Novu Connect","sidebarTitle":"Overview","href":"/agents/managed-agent/overview"},{"title":"Concepts","href":"/agents/managed-agent/concepts"},{"title":"Configure MCP servers","href":"/agents/managed-agent/configure-mcp-servers"},{"title":"Add skills","href":"/agents/managed-agent/add-skills"}]},{"group":"Observability","icon":"eye","pages":[{"title":"Agent Conversations","href":"/agents/conversations"}]}]},{"tab":"API Reference","groups":[{"group":"Getting Started","pages":[{"title":"Novu REST API Reference","sidebarTitle":"Overview","href":"/api-reference"},{"title":"Authentication","href":"/api-reference/authentication"},{"title":"Errors","href":"/api-reference/errors"},{"title":"Pagination","href":"/api-reference/pagination"},{"title":"Rate Limiting","href":"/api-reference/rate-limiting"},{"title":"Idempotency","href":"/api-reference/idempotency"},{"title":"Payload Limits","href":"/api-reference/payload-limits"}]},{"group":"Notification delivery","icon":"send","pages":[{"group":"Events","expanded":false,"pages":[{"title":"Trigger event","openapi":"POST /v1/events/trigger","href":"/api-reference/events/trigger-event"},{"title":"Bulk trigger event","openapi":"POST /v1/events/trigger/bulk","href":"/api-reference/events/bulk-trigger-event"},{"title":"Broadcast event to all","openapi":"POST /v1/events/trigger/broadcast","href":"/api-reference/events/broadcast-event-to-all"},{"title":"Cancel triggered event","openapi":"DELETE /v1/events/trigger/{transactionId}","href":"/api-reference/events/cancel-triggered-event"}]},{"group":"Notifications","expanded":false,"pages":[{"title":"Notification event schema","sidebarTitle":"Schema","href":"/api-reference/notifications/notification-event-schema"},{"title":"List all events","openapi":"GET /v1/notifications","href":"/api-reference/notifications/list-all-events"},{"title":"Retrieve an event","openapi":"GET /v1/notifications/{notificationId}","href":"/api-reference/notifications/retrieve-an-event"}]},{"group":"Messages","expanded":false,"pages":[{"title":"Message schema","sidebarTitle":"Schema","href":"/api-reference/messages/message-schema"},{"title":"List all messages","openapi":"GET /v1/messages","href":"/api-reference/messages/list-all-messages"},{"title":"Delete a message","openapi":"DELETE /v1/messages/{messageId}","href":"/api-reference/messages/delete-a-message"},{"title":"Delete messages by transactionId","openapi":"DELETE /v1/messages/transaction/{transactionId}","href":"/api-reference/messages/delete-messages-by-transactionid"}]},{"group":"Activity","expanded":false,"pages":[{"title":"Track activity and engagement events","openapi":"POST /v2/inbound-webhooks/delivery-providers/{environmentId}/{integrationId}","href":"/api-reference/activity/track-activity-and-engagement-events"}]}]},{"group":"Agents","icon":"bot","pages":[{"title":"Agent schema","sidebarTitle":"Schema","href":"/api-reference/agents/agent-schema"},{"group":"Management","expanded":false,"pages":[{"title":"Create an agent","openapi":"POST /v1/agents","href":"/api-reference/agents/create-an-agent"},{"title":"List all agents","openapi":"GET /v1/agents","href":"/api-reference/agents/list-all-agents"},{"title":"Retrieve an agent","openapi":"GET /v1/agents/{identifier}","href":"/api-reference/agents/retrieve-an-agent"},{"title":"Update an agent","openapi":"PATCH /v1/agents/{identifier}","href":"/api-reference/agents/update-an-agent"},{"title":"Delete an agent","openapi":"DELETE /v1/agents/{identifier}","href":"/api-reference/agents/delete-an-agent"}]},{"group":"Runtime","expanded":false,"pages":[{"title":"Update an agent bridge","openapi":"PUT /v1/agents/{identifier}/bridge","href":"/api-reference/agents/update-an-agent-bridge"},{"title":"Send an agent reply","openapi":"POST /v1/agents/{agentId}/reply","href":"/api-reference/agents/send-an-agent-reply"}]},{"group":"Integrations","expanded":false,"pages":[{"title":"Create an agent integration","openapi":"POST /v1/agents/{identifier}/integrations","href":"/api-reference/agents/create-an-agent-integration"},{"title":"List agent integrations","openapi":"GET /v1/agents/{identifier}/integrations","href":"/api-reference/agents/list-agent-integrations"},{"title":"Update an agent integration","openapi":"PATCH /v1/agents/{identifier}/integrations/{agentIntegrationId}","href":"/api-reference/agents/update-an-agent-integration"},{"title":"Delete an agent integration","openapi":"DELETE /v1/agents/{identifier}/integrations/{agentIntegrationId}","href":"/api-reference/agents/delete-an-agent-integration"}]}]},{"group":"Data","icon":"database","pages":[{"group":"Subscribers","expanded":false,"pages":[{"title":"Subscriber schema","sidebarTitle":"Schema","href":"/api-reference/subscribers/subscriber-schema"},{"group":"Management","expanded":false,"pages":[{"title":"Create a subscriber","openapi":"POST /v2/subscribers","href":"/api-reference/subscribers/create-a-subscriber"},{"title":"Retrieve a subscriber","openapi":"GET /v2/subscribers/{subscriberId}","href":"/api-reference/subscribers/retrieve-a-subscriber"},{"title":"Update a subscriber","openapi":"PATCH /v2/subscribers/{subscriberId}","href":"/api-reference/subscribers/update-a-subscriber"},{"title":"Delete a subscriber","openapi":"DELETE /v2/subscribers/{subscriberId}","href":"/api-reference/subscribers/delete-a-subscriber"},{"title":"Search subscribers","openapi":"GET /v2/subscribers","href":"/api-reference/subscribers/search-subscribers"},{"title":"Bulk create subscribers","openapi":"POST /v1/subscribers/bulk","href":"/api-reference/subscribers/bulk-create-subscribers"}]},{"group":"Subscriptions","expanded":false,"pages":[{"title":"Retrieve subscriber subscriptions","openapi":"GET /v2/subscribers/{subscriberId}/subscriptions","href":"/api-reference/subscribers/retrieve-subscriber-subscriptions"}]},{"group":"Preferences","expanded":false,"pages":[{"title":"Retrieve subscriber preferences","openapi":"GET /v2/subscribers/{subscriberId}/preferences","href":"/api-reference/subscribers/retrieve-subscriber-preferences"},{"title":"Update subscriber preferences","openapi":"PATCH /v2/subscribers/{subscriberId}/preferences","href":"/api-reference/subscribers/update-subscriber-preferences"},{"title":"Bulk update subscriber preferences","openapi":"PATCH /v2/subscribers/{subscriberId}/preferences/bulk","href":"/api-reference/subscribers/bulk-update-subscriber-preferences"}]},{"group":"Credentials","expanded":false,"pages":[{"title":"Update provider credentials","openapi":"PUT /v1/subscribers/{subscriberId}/credentials","href":"/api-reference/subscribers/update-provider-credentials"},{"title":"Upsert provider credentials","openapi":"PATCH /v1/subscribers/{subscriberId}/credentials","href":"/api-reference/subscribers/upsert-provider-credentials"},{"title":"Delete provider credentials","openapi":"DELETE /v1/subscribers/{subscriberId}/credentials/{providerId}","href":"/api-reference/subscribers/delete-provider-credentials"}]},{"group":"Notification state","expanded":false,"pages":[{"title":"Retrieve subscriber notifications","openapi":"GET /v1/subscribers/{subscriberId}/notifications/feed","href":"/api-reference/subscribers/retrieve-subscriber-notifications"},{"title":"Update notifications state","openapi":"POST /v1/subscribers/{subscriberId}/messages/mark-as","href":"/api-reference/subscribers/update-notifications-state"},{"title":"Update all notifications state","openapi":"POST /v1/subscribers/{subscriberId}/messages/mark-all","href":"/api-reference/subscribers/update-all-notifications-state"},{"title":"Update subscriber online status","openapi":"PATCH /v1/subscribers/{subscriberId}/online-status","href":"/api-reference/subscribers/update-subscriber-online-status"},{"title":"Retrieve unseen notifications count","openapi":"GET /v1/subscribers/{subscriberId}/notifications/unseen","href":"/api-reference/subscribers/retrieve-unseen-notifications-count"},{"title":"Update notification action status","openapi":"POST /v1/subscribers/{subscriberId}/messages/{messageId}/actions/{type}","href":"/api-reference/subscribers/update-notification-action-status"}]}]},{"group":"Inbox","expanded":false,"pages":[{"group":"Counts","expanded":false,"pages":[{"title":"Retrieve subscriber notifications count","openapi":"GET /v2/subscribers/{subscriberId}/notifications/count","href":"/api-reference/subscribers/retrieve-subscriber-notifications-count"}]},{"group":"Read \u0026 seen","expanded":false,"pages":[{"title":"Mark a notification as read","openapi":"PATCH /v2/subscribers/{subscriberId}/notifications/{notificationId}/read","href":"/api-reference/subscribers/mark-a-notification-as-read"},{"title":"Mark a notification as unread","openapi":"PATCH /v2/subscribers/{subscriberId}/notifications/{notificationId}/unread","href":"/api-reference/subscribers/mark-a-notification-as-unread"},{"title":"Mark all notifications as read","openapi":"POST /v2/subscribers/{subscriberId}/notifications/read","href":"/api-reference/subscribers/mark-all-notifications-as-read"},{"title":"Mark notifications as seen","openapi":"POST /v2/subscribers/{subscriberId}/notifications/seen","href":"/api-reference/subscribers/mark-notifications-as-seen"}]},{"group":"Snooze","expanded":false,"pages":[{"title":"Snooze a notification","openapi":"PATCH /v2/subscribers/{subscriberId}/notifications/{notificationId}/snooze","href":"/api-reference/subscribers/snooze-a-notification"},{"title":"Unsnooze a notification","openapi":"PATCH /v2/subscribers/{subscriberId}/notifications/{notificationId}/unsnooze","href":"/api-reference/subscribers/unsnooze-a-notification"}]},{"group":"Archive","expanded":false,"pages":[{"title":"Archive a notification","openapi":"PATCH /v2/subscribers/{subscriberId}/notifications/{notificationId}/archive","href":"/api-reference/subscribers/archive-a-notification"},{"title":"Unarchive a notification","openapi":"PATCH /v2/subscribers/{subscriberId}/notifications/{notificationId}/unarchive","href":"/api-reference/subscribers/unarchive-a-notification"},{"title":"Archive all notifications","openapi":"POST /v2/subscribers/{subscriberId}/notifications/archive","href":"/api-reference/subscribers/archive-all-notifications"},{"title":"Archive all read notifications","openapi":"POST /v2/subscribers/{subscriberId}/notifications/read-archive","href":"/api-reference/subscribers/archive-all-read-notifications"}]},{"group":"Delete","expanded":false,"pages":[{"title":"Delete a notification","openapi":"DELETE /v2/subscribers/{subscriberId}/notifications/{notificationId}","href":"/api-reference/subscribers/delete-a-notification"},{"title":"Delete all notifications","openapi":"POST /v2/subscribers/{subscriberId}/notifications/delete","href":"/api-reference/subscribers/delete-all-notifications"}]},{"group":"Actions","expanded":false,"pages":[{"title":"Complete a notification action","openapi":"PATCH /v2/subscribers/{subscriberId}/notifications/{notificationId}/actions/{actionType}/complete","href":"/api-reference/subscribers/complete-a-notification-action"},{"title":"Revert a notification action","openapi":"PATCH /v2/subscribers/{subscriberId}/notifications/{notificationId}/actions/{actionType}/revert","href":"/api-reference/subscribers/revert-a-notification-action"}]}]},{"group":"Topics","expanded":false,"pages":[{"title":"Topic schema","sidebarTitle":"Schema","href":"/api-reference/topics/topic-schema"},{"group":"Management","expanded":false,"pages":[{"title":"Create a topic","openapi":"POST /v2/topics","href":"/api-reference/topics/create-a-topic"},{"title":"Retrieve a topic","openapi":"GET /v2/topics/{topicKey}","href":"/api-reference/topics/retrieve-a-topic"},{"title":"Update a topic","openapi":"PATCH /v2/topics/{topicKey}","href":"/api-reference/topics/update-a-topic"},{"title":"Delete a topic","openapi":"DELETE /v2/topics/{topicKey}","href":"/api-reference/topics/delete-a-topic"},{"title":"List all topics","openapi":"GET /v2/topics","href":"/api-reference/topics/list-all-topics"}]},{"group":"Subscriptions","expanded":false,"pages":[{"title":"Create topic subscriptions","openapi":"POST /v2/topics/{topicKey}/subscriptions","href":"/api-reference/topics/create-topic-subscriptions"},{"title":"Delete topic subscriptions","openapi":"DELETE /v2/topics/{topicKey}/subscriptions","href":"/api-reference/topics/delete-topic-subscriptions"},{"title":"Update a topic subscription","openapi":"PATCH /v2/topics/{topicKey}/subscriptions/{identifier}","href":"/api-reference/topics/update-a-topic-subscription"},{"title":"List topic subscriptions","openapi":"GET /v2/topics/{topicKey}/subscriptions","href":"/api-reference/topics/list-topic-subscriptions"},{"title":"Check topic subscriber","openapi":"GET /v1/topics/{topicKey}/subscribers/{externalSubscriberId}","href":"/api-reference/topics/check-topic-subscriber"},{"title":"Retrieve a topic subscription","openapi":"GET /v2/topics/{topicKey}/subscriptions/{identifier}","href":"/api-reference/topics/retrieve-a-topic-subscription"}]}]},{"group":"Contexts","expanded":false,"pages":[{"title":"Context schema","sidebarTitle":"Schema","href":"/api-reference/contexts/context-schema"},{"title":"Create a context","openapi":"POST /v2/contexts","href":"/api-reference/contexts/create-a-context"},{"title":"Retrieve a context","openapi":"GET /v2/contexts/{type}/{id}","href":"/api-reference/contexts/retrieve-a-context"},{"title":"Update a context","openapi":"PATCH /v2/contexts/{type}/{id}","href":"/api-reference/contexts/update-a-context"},{"title":"Delete a context","openapi":"DELETE /v2/contexts/{type}/{id}","href":"/api-reference/contexts/delete-a-context"},{"title":"List all contexts","openapi":"GET /v2/contexts","href":"/api-reference/contexts/list-all-contexts"}]},{"group":"Channel Connections","expanded":false,"pages":[{"title":"Create a channel connection","openapi":"POST /v1/channel-connections","href":"/api-reference/channel-connections/create-a-channel-connection"},{"title":"Retrieve a channel connection","openapi":"GET /v1/channel-connections/{identifier}","href":"/api-reference/channel-connections/retrieve-a-channel-connection"},{"title":"Update a channel connection","openapi":"PATCH /v1/channel-connections/{identifier}","href":"/api-reference/channel-connections/update-a-channel-connection"},{"title":"Delete a channel connection","openapi":"DELETE /v1/channel-connections/{identifier}","href":"/api-reference/channel-connections/delete-a-channel-connection"},{"title":"List all channel connections","openapi":"GET /v1/channel-connections","href":"/api-reference/channel-connections/list-all-channel-connections"}]},{"group":"Channel Endpoints","expanded":false,"pages":[{"title":"Create a channel endpoint","openapi":"POST /v1/channel-endpoints","href":"/api-reference/channel-endpoints/create-a-channel-endpoint"},{"title":"Retrieve a channel endpoint","openapi":"GET /v1/channel-endpoints/{identifier}","href":"/api-reference/channel-endpoints/retrieve-a-channel-endpoint"},{"title":"Update a channel endpoint","openapi":"PATCH /v1/channel-endpoints/{identifier}","href":"/api-reference/channel-endpoints/update-a-channel-endpoint"},{"title":"Delete a channel endpoint","openapi":"DELETE /v1/channel-endpoints/{identifier}","href":"/api-reference/channel-endpoints/delete-a-channel-endpoint"},{"title":"List all channel endpoints","openapi":"GET /v1/channel-endpoints","href":"/api-reference/channel-endpoints/list-all-channel-endpoints"}]}]},{"group":"Workflows \u0026 content","icon":"git-branch","pages":[{"group":"Workflows","expanded":false,"pages":[{"title":"Workflow schema","sidebarTitle":"Schema","href":"/api-reference/workflows/workflow-schema"},{"title":"Create a workflow","openapi":"POST /v2/workflows","href":"/api-reference/workflows/create-a-workflow"},{"title":"Retrieve a workflow","openapi":"GET /v2/workflows/{workflowId}","href":"/api-reference/workflows/retrieve-a-workflow"},{"title":"Update a workflow","openapi":"PUT /v2/workflows/{workflowId}","href":"/api-reference/workflows/update-a-workflow"},{"title":"Delete a workflow","openapi":"DELETE /v2/workflows/{workflowId}","href":"/api-reference/workflows/delete-a-workflow"},{"title":"List all workflows","openapi":"GET /v2/workflows","href":"/api-reference/workflows/list-all-workflows"},{"title":"Sync a workflow","openapi":"PUT /v2/workflows/{workflowId}/sync","href":"/api-reference/workflows/sync-a-workflow"},{"title":"Retrieve workflow step","openapi":"GET /v2/workflows/{workflowId}/steps/{stepId}","href":"/api-reference/workflows/retrieve-workflow-step"},{"title":"Generate a step preview","openapi":"POST /v2/workflows/{workflowId}/step/{stepId}/preview","href":"/api-reference/workflows/generate-a-step-preview"}]},{"group":"Translations","expanded":false,"pages":[{"title":"Create a translation","openapi":"POST /v2/translations","href":"/api-reference/translations/create-a-translation"},{"title":"Retrieve a translation","openapi":"GET /v2/translations/{resourceType}/{resourceId}/{locale}","href":"/api-reference/translations/retrieve-a-translation"},{"title":"Delete a translation","openapi":"DELETE /v2/translations/{resourceType}/{resourceId}/{locale}","href":"/api-reference/translations/delete-a-translation"},{"title":"Retrieve a translation group","openapi":"GET /v2/translations/group/{resourceType}/{resourceId}","href":"/api-reference/translations/retrieve-a-translation-group"},{"title":"Delete a translation group","openapi":"DELETE /v2/translations/{resourceType}/{resourceId}","href":"/api-reference/translations/delete-a-translation-group"},{"title":"Import master translations JSON","openapi":"POST /v2/translations/master-json","href":"/api-reference/translations/import-master-translations-json"},{"title":"Retrieve master translations JSON","openapi":"GET /v2/translations/master-json","href":"/api-reference/translations/retrieve-master-translations-json"},{"title":"Upload master translations JSON file","openapi":"POST /v2/translations/master-json/upload","href":"/api-reference/translations/upload-master-translations-json-file"},{"title":"Upload translation files","openapi":"POST /v2/translations/upload","href":"/api-reference/translations/upload-translation-files"}]},{"group":"Layouts","expanded":false,"pages":[{"title":"Create a layout","openapi":"POST /v2/layouts","href":"/api-reference/layouts/create-a-layout"},{"title":"Delete a layout","openapi":"DELETE /v2/layouts/{layoutId}","href":"/api-reference/layouts/delete-a-layout"},{"title":"Duplicate a layout","openapi":"POST /v2/layouts/{layoutId}/duplicate","href":"/api-reference/layouts/duplicate-a-layout"},{"title":"Generate layout preview","openapi":"POST /v2/layouts/{layoutId}/preview","href":"/api-reference/layouts/generate-layout-preview"},{"title":"Get layout usage","openapi":"GET /v2/layouts/{layoutId}/usage","href":"/api-reference/layouts/get-layout-usage"},{"title":"List all layouts","openapi":"GET /v2/layouts","href":"/api-reference/layouts/list-all-layouts"},{"title":"Retrieve a layout","openapi":"GET /v2/layouts/{layoutId}","href":"/api-reference/layouts/retrieve-a-layout"},{"title":"Update a layout","openapi":"PUT /v2/layouts/{layoutId}","href":"/api-reference/layouts/update-a-layout"}]}]},{"group":"Platform \u0026 channels","icon":"settings","pages":[{"group":"Environments","expanded":false,"pages":[{"title":"Environment schema","sidebarTitle":"Schema","href":"/api-reference/environments/environment-schema"},{"title":"Create an environment","openapi":"POST /v1/environments","href":"/api-reference/environments/create-an-environment"},{"title":"Update an environment","openapi":"PUT /v1/environments/{environmentId}","href":"/api-reference/environments/update-an-environment"},{"title":"Delete an environment","openapi":"DELETE /v1/environments/{environmentId}","href":"/api-reference/environments/delete-an-environment"},{"title":"List all environments","openapi":"GET /v1/environments","href":"/api-reference/environments/list-all-environments"},{"title":"List environment tags","openapi":"GET /v2/environments/{environmentId}/tags","href":"/api-reference/environments/list-environment-tags"},{"title":"Compare resources between environments","openapi":"POST /v2/environments/{targetEnvironmentId}/diff","href":"/api-reference/environments/compare-resources-between-environments"},{"title":"Publish resources to target environment","openapi":"POST /v2/environments/{targetEnvironmentId}/publish","href":"/api-reference/environments/publish-resources-to-target-environment"}]},{"group":"Environment Variables","expanded":false,"pages":[{"title":"Environment variable schema","sidebarTitle":"Schema","href":"/api-reference/environment-variables/environment-variable-schema"},{"title":"Create a variable","openapi":"POST /v1/environment-variables","href":"/api-reference/environment-variables/create-a-variable"},{"title":"Retrieve a variable","openapi":"GET /v1/environment-variables/{variableKey}","href":"/api-reference/environment-variables/retrieve-a-variable"},{"title":"Update a variable","openapi":"PATCH /v1/environment-variables/{variableKey}","href":"/api-reference/environment-variables/update-a-variable"},{"title":"Delete a variable","openapi":"DELETE /v1/environment-variables/{variableKey}","href":"/api-reference/environment-variables/delete-a-variable"},{"title":"List all variables","openapi":"GET /v1/environment-variables","href":"/api-reference/environment-variables/list-all-variables"},{"title":"Retrieve a variable usage","openapi":"GET /v1/environment-variables/{variableKey}/usage","href":"/api-reference/environment-variables/retrieve-a-variable-usage"}]},{"group":"Integrations","expanded":false,"pages":[{"title":"Integration schema","sidebarTitle":"Schema","href":"/api-reference/integrations/integration-schema"},{"title":"Create an integration","openapi":"POST /v1/integrations","href":"/api-reference/integrations/create-an-integration"},{"title":"Update an integration","openapi":"PUT /v1/integrations/{integrationId}","href":"/api-reference/integrations/update-an-integration"},{"title":"Delete an integration","openapi":"DELETE /v1/integrations/{integrationId}","href":"/api-reference/integrations/delete-an-integration"},{"title":"List all integrations","openapi":"GET /v1/integrations","href":"/api-reference/integrations/list-all-integrations"},{"title":"List active integrations","openapi":"GET /v1/integrations/active","href":"/api-reference/integrations/list-active-integrations"},{"title":"Update integration as primary","openapi":"POST /v1/integrations/{integrationId}/set-primary","href":"/api-reference/integrations/update-integration-as-primary"},{"title":"Generate chat OAuth URL","openapi":"POST /v1/integrations/chat/oauth","href":"/api-reference/integrations/generate-chat-oauth-url"},{"title":"Auto-configure an integration for inbound webhooks","openapi":"POST /v1/integrations/{integrationId}/auto-configure","href":"/api-reference/integrations/auto-configure-an-integration-for-inbound-webhooks"}]}]}]},{"tab":"Resources","menu":[{"item":"Guides","groups":[{"group":"Guides","icon":"book-open","pages":[{"title":"Novu Integration Guides and Recipes","sidebarTitle":"Overview","href":"/guides"},{"group":"Use Cases","expanded":false,"pages":[{"title":"Transactional Notifications with Novu","sidebarTitle":"Transactional","href":"/guides/use-cases/transactional-notifications"},{"title":"Password Reset and Auth Alert Notifications","sidebarTitle":"Password reset","href":"/guides/use-cases/password-reset-notifications"},{"title":"Digest and Batched Notifications","sidebarTitle":"Digest","href":"/guides/use-cases/digest-notifications"},{"title":"Multi-Channel Notification Fallback Workflows","sidebarTitle":"Multi-channel fallback","href":"/guides/use-cases/multi-channel-fallback"},{"title":"User Notification Preferences with Novu","sidebarTitle":"Preferences","href":"/guides/use-cases/notification-preferences"}]},{"group":"Workflow automation","expanded":false,"pages":[{"title":"Inngest","href":"/guides/inngest"},{"title":"Trigger.dev","href":"/guides/triggerdotdev"}]},{"group":"Incoming webhooks","expanded":false,"pages":[{"title":"Clerk","href":"/guides/webhooks/clerk"},{"title":"Auth0 Webhook Integration with Novu","sidebarTitle":"Auth0","href":"/guides/webhooks/auth0"},{"title":"Stripe","href":"/guides/webhooks/stripe"}]},{"group":"Webhook connectors","expanded":false,"pages":[{"group":"Data warehouses","expanded":false,"pages":[{"title":"Export notification events to a data warehouse","sidebarTitle":"Plan your export","href":"/guides/webhook-connectors/data-warehouse-sync"},{"title":"Insert webhook events into ClickHouse","sidebarTitle":"ClickHouse","href":"/guides/webhook-connectors/clickhouse"},{"title":"Stream webhook events into Google BigQuery","sidebarTitle":"Google BigQuery","href":"/guides/webhook-connectors/google-bigquery"},{"title":"Load webhook events into Snowflake","sidebarTitle":"Snowflake","href":"/guides/webhook-connectors/snowflake"},{"title":"Load webhook events into Amazon Redshift","sidebarTitle":"Amazon Redshift","href":"/guides/webhook-connectors/amazon-redshift"},{"title":"Insert webhook events into Postgres","sidebarTitle":"Postgres","href":"/guides/webhook-connectors/postgres"}]},{"group":"Object storage","expanded":false,"pages":[{"title":"Store webhook events in Amazon S3","sidebarTitle":"Amazon S3","href":"/guides/webhook-connectors/amazon-s3"},{"title":"Send webhook events to Azure Blob Storage","sidebarTitle":"Azure Blob Storage","href":"/guides/webhook-connectors/azure-blob-storage"},{"title":"Send webhook events to Google Cloud Storage","sidebarTitle":"Google Cloud Storage","href":"/guides/webhook-connectors/google-cloud-storage"}]},{"group":"Messaging","expanded":false,"pages":[{"title":"Send webhook events to Amazon SQS","sidebarTitle":"Amazon SQS","href":"/guides/webhook-connectors/amazon-sqs"},{"title":"Publish webhook events to Amazon SNS","sidebarTitle":"Amazon SNS","href":"/guides/webhook-connectors/amazon-sns"},{"title":"Send webhook events to Amazon EventBridge","sidebarTitle":"Amazon EventBridge","href":"/guides/webhook-connectors/amazon-eventbridge"},{"title":"Publish webhook events to RabbitMQ","sidebarTitle":"RabbitMQ","href":"/guides/webhook-connectors/rabbitmq"},{"title":"Publish webhook events to Google Cloud Pub/Sub","sidebarTitle":"Google Cloud Pub/Sub","href":"/guides/webhook-connectors/google-cloud-pubsub"}]},{"group":"Analytics \u0026 observability","expanded":false,"pages":[{"title":"Send webhook events to Segment","sidebarTitle":"Segment","href":"/guides/webhook-connectors/segment"},{"title":"Send webhook events to an OpenTelemetry Collector","sidebarTitle":"OpenTelemetry Collector","href":"/guides/webhook-connectors/opentelemetry-collector"}]},{"group":"HTTP delivery","expanded":false,"pages":[{"title":"Consume webhook events from a polling endpoint","sidebarTitle":"Polling Endpoint","href":"/guides/webhook-connectors/polling-endpoint"},{"title":"Receive webhook events in FIFO order","sidebarTitle":"FIFO Endpoint","href":"/guides/webhook-connectors/fifo-endpoint"}]}]},{"group":"Data sources","expanded":false,"pages":[{"title":"Segment","href":"/guides/analytics/segment"},{"title":"Hightouch","href":"/guides/analytics/hightouch"},{"title":"Databricks","href":"/guides/analytics/databricks"}]},{"group":"Recipes","expanded":false,"pages":[{"title":"Managing Workflows","href":"/guides/recipes/managing-workflows"},{"title":"Supabase Auth Notifications with Novu","sidebarTitle":"Supabase auth","href":"/guides/recipes/supabase-auth-notifications"}]},{"group":"Framework","expanded":false,"pages":[{"title":"Using Translations","href":"/guides/framework/using-translations"}]},{"group":"Migration to New Dashboard","expanded":false,"pages":[{"title":"Migrate from the Legacy Dashboard to the New Dashboard","sidebarTitle":"Migration overview","href":"/guides/migration-to-new-dashboard/overview"},{"title":"Legacy and New Dashboard Feature Comparison","sidebarTitle":"Feature comparison","href":"/guides/migration-to-new-dashboard/feature-comparison"},{"title":"Convert Legacy Workflows for the New Dashboard","sidebarTitle":"Convert workflows","href":"/guides/migration-to-new-dashboard/workflow-conversion"},{"title":"Migrate the Application and Cut Over to New Workflows","sidebarTitle":"Application and cutover","href":"/guides/migration-to-new-dashboard/application-and-cutover"}]},{"group":"Migrate to Novu","pages":[{"title":"Migrate from Courier to Novu","sidebarTitle":"From Courier","href":"/guides/migrate-from-courier-to-novu"},{"title":"Migrate from Knock to Novu","sidebarTitle":"From Knock","href":"/guides/migrate-from-knock-to-novu"},{"title":"Migrate from MagicBell to Novu","sidebarTitle":"From MagicBell","href":"/guides/migrate-from-magicbell-to-novu"},{"title":"Migrate from In-House Notifications to Novu","sidebarTitle":"From in-house","href":"/guides/migrate-from-in-house-to-novu"}]}]}]},{"item":"Framework","groups":[{"group":"Getting Started","boost":0.1,"pages":[{"title":"Novu Framework - Code-First Notification Workflows","sidebarTitle":"Overview","href":"/framework"},{"title":"Introduction","href":"/framework/introduction"},{"group":"Quickstart","pages":[{"title":"Next.js","href":"/framework/quickstart/nextjs"},{"title":"Express","href":"/framework/quickstart/express"},{"title":"Remix","href":"/framework/quickstart/remix"},{"title":"NestJS","href":"/framework/quickstart/nestjs"},{"title":"SvelteKit","href":"/framework/quickstart/svelte"},{"title":"Nuxt quickstart for Novu Framework","sidebarTitle":"Nuxt","href":"/framework/quickstart/nuxt"},{"title":"H3","href":"/framework/quickstart/h3"},{"title":"Hono","href":"/framework/quickstart/hono"},{"title":"AWS Lambda","href":"/framework/quickstart/lambda"}]}]},{"group":"Core Concepts","boost":0.1,"icon":"blocks","pages":[{"title":"Local development","sidebarTitle":"Local development","href":"/framework/studio"},{"title":"Bridge Endpoint","href":"/framework/endpoint"},{"title":"Bridge request errors","sidebarTitle":"Errors","href":"/framework/errors"},{"title":"Tags","href":"/framework/tags"},{"title":"Payload","href":"/framework/payload"},{"title":"Controls","href":"/framework/controls"}]},{"group":"Channels","boost":0.1,"icon":"radio","pages":[{"title":"Email","href":"/framework/email-channel"},{"title":"In-App","href":"/framework/in-app-channel"},{"title":"Push","href":"/framework/push-channel"},{"title":"SMS","href":"/framework/sms-channel"},{"title":"Chat","href":"/framework/chat-channel"},{"title":"Tool","href":"/framework/tool-channel"}]},{"group":"Content","boost":0.1,"icon":"file-text","pages":[{"title":"React Email","href":"/framework/content/react-email"},{"title":"Remix \u0026 React Email","href":"/framework/content/remix-react-email"},{"title":"Svelte Email","href":"/framework/content/svelte-email"},{"title":"Vue Email","href":"/framework/content/vue-email"}]},{"group":"Advanced Features","boost":0.1,"icon":"sparkles","pages":[{"title":"Digest Action","href":"/framework/digest"},{"title":"Delay Action","href":"/framework/delay"},{"title":"Custom Step","href":"/framework/custom"},{"title":"Skip Function","href":"/framework/skip"}]},{"group":"API Reference","boost":0.1,"icon":"code","pages":[{"title":"Novu Framework TypeScript SDK Overview","sidebarTitle":"Overview","href":"/framework/typescript/overview"},{"title":"Client","href":"/framework/typescript/client"},{"title":"Workflow","href":"/framework/typescript/workflow"},{"group":"Steps","pages":[{"title":"Steps","href":"/framework/typescript/steps"},{"title":"Chat","href":"/framework/typescript/steps/chat"},{"title":"Email","href":"/framework/typescript/steps/email"},{"title":"In-App","href":"/framework/typescript/steps/inApp"},{"title":"Push","href":"/framework/typescript/steps/push"},{"title":"SMS","href":"/framework/typescript/steps/sms"},{"title":"Tool","href":"/framework/typescript/steps/tool"},{"title":"Custom","href":"/framework/typescript/steps/custom"},{"title":"Delay","href":"/framework/typescript/steps/delay"},{"title":"Digest","href":"/framework/typescript/steps/digest"}]},{"title":"Zod","href":"/framework/schema/zod"},{"title":"JSON Schema","href":"/framework/schema/json-schema"},{"title":"Class Validator","href":"/framework/schema/class-validator"}]},{"group":"Deployment","boost":0.1,"icon":"cloud-upload","pages":[{"title":"Production Deployment Guide","href":"/framework/deployment/production"},{"title":"Syncing","href":"/framework/deployment/syncing"},{"title":"Deploy workflows with the Novu CLI","sidebarTitle":"CLI","href":"/framework/deployment/cli"},{"title":"GitHub Actions","href":"/framework/deployment/actions"}]}]},{"item":"Community","groups":[{"group":"Getting Started","boost":0.1,"pages":[{"title":"Community Overview","href":"/community"},{"group":"Self Hosting Novu","boost":1,"pages":[{"title":"Self-Host Novu - Open-Source Notification Infrastructure","sidebarTitle":"Self-hosting","href":"/community/self-hosting-novu/overview"},{"title":"Deploy with Docker","href":"/community/self-hosting-novu/deploy-with-docker"},{"title":"Telemetry","href":"/community/self-hosting-novu/telemetry"},{"title":"Data Migrations","href":"/community/self-hosting-novu/data-migrations"},{"title":"Migrate from v0 to v2 Dashboard","href":"/community/self-hosting-novu/v0-to-v2-migration"}]},{"title":"Get Involved","href":"/community/get-involved"},{"title":"Code of Conduct","href":"/community/code-of-conduct"},{"title":"Roadmap","href":"/community/roadmap"},{"title":"Changelog","href":"/community/changelog"},{"title":"Self-Hosted and Novu Cloud","href":"/community/self-hosted-and-novu-cloud"},{"title":"Run Novu in local machine","href":"/community/run-in-local-machine"},{"title":"Add a New Provider","href":"/community/add-a-new-provider"}]}]}]}]},"title":"Installation - Novu","buildId":"dpl_EnxDqhjaNc9a8MVa833TGULPd9uJ","deploymentId":"dpl_EnxDqhjaNc9a8MVa833TGULPd9uJ","dynamics":[],"chunks":[]}