In this page you can learn about how rate limiting works with Novu’s API
This feature is available from v0.22.0.
Rate limiting is an essential functionality for establishing a robust and resilient system. It safeguards system resources from being misused by malicious actors or being monopolized by one client.A variable-cost token bucket rate limited algorithm has been added to provide the capability for different API controllers and methods to have a varying cost. It also lays a foundation for dynamic costing of resource consumption.
The following limits apply to each category of the Novu system. Each category has an independent bucket of rate-limit tokens to consume.
Bulk requests have a rate limit cost of 100 times the base limit and consume from the same token pool. For example, the free tier would allow a combined maximum of 10 standard trigger events and 2 bulk trigger events in the same 1-second window.
Category
Free
Business
Endpoints
Events
60 rps
600 rps
Trigger
Configuration
15 rps
150 rps
Subscribers, Topics, Tenants
Global
30 rps
300 rps
All other endpoints consume rate limiting tokens from this category.
Was this page helpful?
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Novu","colors":{"primary":"#0055ff","light":"#00d5ff","dark":"#0055ff"},"logo":{"light":"https://mintcdn.com/novu-v2-docs/VG9mq1_LJq1HEO4o/logo/novu-light.svg?fit=max\u0026auto=format\u0026n=VG9mq1_LJq1HEO4o\u0026q=85\u0026s=7eacd7fa5f8962ea593e8b499c2933e4","dark":"https://mintcdn.com/novu-v2-docs/VG9mq1_LJq1HEO4o/logo/novu-dark.svg?fit=max\u0026auto=format\u0026n=VG9mq1_LJq1HEO4o\u0026q=85\u0026s=275f6d49242a214e9af7ec7a0714d139"},"favicon":"https://mintcdn.com/novu-v2-docs/YYAvm31YUpJTIUru/favicon.png?fit=max\u0026auto=format\u0026n=YYAvm31YUpJTIUru\u0026q=85\u0026s=1482d60682c67f8d7253cbced80d90ca","api":{"openapi":"https://api.novu.co/openapi.json","mdx":{"auth":{"method":"key","name":"Authorization"},"server":["https://api.novu.co","https://eu.api.novu.co"]}},"background":{"image":"https://mintcdn.com/novu-v2-docs/YYAvm31YUpJTIUru/background.png?fit=max\u0026auto=format\u0026n=YYAvm31YUpJTIUru\u0026q=85\u0026s=956f7a984e350d08a1d84cdec70f4b4b","color":{"light":"#ffffff","dark":"#000000"}},"navbar":{"links":[{"href":"https://docs.novu.co?utm_campaign=v0.24.x-docs_top_nav","label":"v2 Docs"},{"href":"https://novu.co/pricing/?utm_campaign=v0.24.x-docs_top_nav","label":"Pricing"},{"href":"https://novu.co/blog/?utm_campaign=v0.24.x-docs_top_nav","label":"Blog"},{"href":"https://novu.co/contact-us/?utm_campaign=v0.24.x-docs_top_nav","label":"Contact us"}],"primary":{"type":"github","href":"https://github.com/novuhq/novu"}},"footer":{"socials":{"twitter":"https://twitter.com/novuhq","github":"https://github.com/novuhq","linkedin":"https://www.linkedin.com/company/novuco"}},"seo":{"metatags":{"og:image":"https://novu.co/images/social-preview.jpg","robots":"noindex"},"indexing":"navigable"},"integrations":{"intercom":{"appId":"fqe0apnx"},"plausible":{"domain":"docs.novu.co"}},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"novu-v2-docs","hasAudioNarration":false,"actualSubdomain":"novu-v2-docs","customDomains":["v0.x-docs.novu.co"],"gitSource":{"type":"github","owner":"novuhq","repo":"docs","deployBranch":"v0.x-docs","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"feedback":{"thumbs":true,"edits":true,"issues":true},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6ae920e3419981b2769dc971:success","clientVersion":"0.0.4087","searchFilterCounts":[{"language":"default","tag":"Documentation","count":356},{"language":"default","tag":"API Reference","count":202},{"language":"default","tag":"Channels \u0026 Providers","count":54},{"language":"default","tag":"Guides","count":46},{"language":"default","tag":"Framework (Code-First)","count":33},{"language":"default","tag":"Subscribers","count":23},{"language":"default","tag":"Getting Started","count":22},{"language":"default","tag":"Email","count":18},{"language":"default","tag":"SMS","count":18},{"language":"default","tag":"Quickstarts","count":17}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"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":"rbac-expansion","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":"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":"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":"full-page-search","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":"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":"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":"turbopuffer-dual-write","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},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"comment-mode","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/rate-limiting","slug":"/api-reference/rate-limiting","pageMetadata":{"title":"API Rate Limiting","description":"In this page you can learn about how rate limiting works with Novu's API","href":"/api-reference/rate-limiting"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"In this page you can learn about how rate limiting works with Novu’s API\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"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={p:`p`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,..._provideComponents(),...props.components},{Heading,Note,Table}=_components;if(!Heading)_missingMdxReference(`Heading`,true);if(!Note)_missingMdxReference(`Note`,true);if(!Table)_missingMdxReference(`Table`,true);return _jsxs(_Fragment,{children:[_jsx(Note,{children:_jsx(_components.p,{children:`This feature is available from v0.22.0.`})}),`\n`,_jsx(_components.p,{children:`Rate limiting is an essential functionality for establishing a robust and resilient system. It safeguards system resources from being misused by malicious actors or being monopolized by one client.`}),`\n`,_jsx(_components.p,{children:`A variable-cost token bucket rate limited algorithm has been added to provide the capability for different API controllers and methods to have a varying cost. It also lays a foundation for dynamic costing of resource consumption.`}),`\n`,_jsx(Heading,{level:`2`,id:`limits`,children:`Limits`}),`\n`,_jsx(_components.p,{children:`The following limits apply to each category of the Novu system. Each category has an independent bucket of rate-limit tokens to consume.\nBulk requests have a rate limit cost of 100 times the base limit and consume from the same token pool. For example, the free tier would allow a combined maximum of 10 standard trigger events and 2 bulk trigger events in the same 1-second window.`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Category`}),_jsx(_components.th,{children:`Free`}),_jsx(_components.th,{children:`Business`}),_jsx(_components.th,{children:`Endpoints`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Events`}),_jsx(_components.td,{children:`60 rps`}),_jsx(_components.td,{children:`600 rps`}),_jsx(_components.td,{children:`Trigger`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Configuration`}),_jsx(_components.td,{children:`15 rps`}),_jsx(_components.td,{children:`150 rps`}),_jsx(_components.td,{children:`Subscribers, Topics, Tenants`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Global`}),_jsx(_components.td,{children:`30 rps`}),_jsx(_components.td,{children:`300 rps`}),_jsx(_components.td,{children:`All other endpoints consume rate limiting tokens from this category.`})]})]})]})]})}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":"API Rate Limiting","description":"In this page you can learn about how rate limiting works with Novu's API","href":"/api-reference/rate-limiting"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Limits","slug":"limits","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":["/_mintlify/custom/novu-v2-docs/7fac7b8abaef5f40/echo-terminal.js","/_mintlify/custom/novu-v2-docs/eed67aa1570b4055/google-tag-manager.js","/_mintlify/custom/novu-v2-docs/4fe39a51663894fd/hubspot.js","/_mintlify/custom/novu-v2-docs/3c623cb7116f058c/linkedin-insights.js","/_mintlify/custom/novu-v2-docs/19b29f44574d1bc1/linkedin.js"],"subdomain":"novu-v2-docs","siteName":"Novu","title":"API Rate Limiting - Novu","navMaps":{"firstHrefInVersion":{"v0.24.x":{"href":"/api-reference/rate-limiting","matchLevel":0},"v0.23.0":{"href":"/api-reference/rate-limiting","matchLevel":0},"v0.22.0":{"href":"/api-reference/rate-limiting","matchLevel":0},"v0.21.0":{"href":"/api-reference/rate-limiting","matchLevel":0},"v0.20.0":{"href":"/api-reference/rate-limiting","matchLevel":0},"v0.19.0":{"href":"/api-reference/rate-limiting","matchLevel":0},"v0.18.0":{"href":"/api-reference/rate-limiting","matchLevel":0}},"firstHrefInLanguage":{}},"lastModified":"2026-01-07T02:46:35.628Z","originalFileLocation":"api-reference/rate-limiting.mdx"},"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=\"description\" content=\"In this page you can learn about how rate limiting works with Novu\u0026#x27;s API\">\u003cmeta data-mint-head name=\"application-name\" content=\"Novu\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003cmeta data-mint-head name=\"robots\" content=\"noindex\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/novu-v2-docs/F-6tYbNQX3GIi-E2/_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-v2-docs/F-6tYbNQX3GIi-E2/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/novu-v2-docs/F-6tYbNQX3GIi-E2/_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-v2-docs/F-6tYbNQX3GIi-E2/_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-v2-docs/F-6tYbNQX3GIi-E2/_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-v2-docs/F-6tYbNQX3GIi-E2/_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-v2-docs/F-6tYbNQX3GIi-E2/_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-v2-docs/F-6tYbNQX3GIi-E2/_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-v2-docs/F-6tYbNQX3GIi-E2/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"API Rate Limiting - Novu\">\u003cmeta data-mint-head property=\"og:description\" content=\"In this page you can learn about how rate limiting works with Novu\u0026#x27;s API\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Novu\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://v0.x-docs.novu.co/api-reference/rate-limiting\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://novu.co/images/social-preview.jpg\">\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=\"API Rate Limiting - Novu\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"In this page you can learn about how rate limiting works with Novu\u0026#x27;s API\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://novu.co/images/social-preview.jpg\">\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-v2-docs/F-6tYbNQX3GIi-E2/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Novu\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0055ff\">\u003clink data-mint-head rel=\"canonical\" href=\"https://v0.x-docs.novu.co/api-reference/rate-limiting\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/rate-limiting.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://v0.x-docs.novu.co/#organization\",\"name\":\"Novu\",\"url\":\"https://v0.x-docs.novu.co\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/novu-v2-docs/VG9mq1_LJq1HEO4o/logo/novu-light.svg?fit=max\u0026auto=format\u0026n=VG9mq1_LJq1HEO4o\u0026q=85\u0026s=7eacd7fa5f8962ea593e8b499c2933e4\"}},{\"@type\":\"WebSite\",\"@id\":\"https://v0.x-docs.novu.co#website\",\"name\":\"Novu\",\"url\":\"https://v0.x-docs.novu.co\",\"publisher\":{\"@id\":\"https://v0.x-docs.novu.co/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://v0.x-docs.novu.co/api-reference/rate-limiting#webpage\",\"url\":\"https://v0.x-docs.novu.co/api-reference/rate-limiting\",\"name\":\"API Rate Limiting\",\"description\":\"In this page you can learn about how rate limiting works with Novu's API\",\"dateModified\":\"2026-01-07T02:46:35.628Z\",\"isPartOf\":{\"@id\":\"https://v0.x-docs.novu.co#website\"},\"breadcrumb\":{\"@id\":\"https://v0.x-docs.novu.co/api-reference/rate-limiting#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://v0.x-docs.novu.co/api-reference/rate-limiting#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API Reference\",\"item\":\"https://v0.x-docs.novu.co/api-reference/overview\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"API Rate Limiting\",\"item\":\"https://v0.x-docs.novu.co/api-reference/rate-limiting\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://v0.x-docs.novu.co/api-reference/rate-limiting#article\",\"headline\":\"API Rate Limiting\",\"name\":\"API Rate Limiting\",\"description\":\"In this page you can learn about how rate limiting works with Novu's API\",\"url\":\"https://v0.x-docs.novu.co/api-reference/rate-limiting\",\"mainEntityOfPage\":{\"@id\":\"https://v0.x-docs.novu.co/api-reference/rate-limiting#webpage\"},\"image\":\"https://novu.co/images/social-preview.jpg\",\"dateModified\":\"2026-01-07T02:46:35.628Z\",\"publisher\":{\"@id\":\"https://v0.x-docs.novu.co/#organization\"},\"isPartOf\":{\"@id\":\"https://v0.x-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":null,"versions":[{"version":"v0.24.x","anchors":[{"anchor":"Documentation","icon":"book-open","pages":[{"title":"Documentation","href":"/getting-started/introduction"}]},{"anchor":"API Reference","icon":"square-terminal","tabs":[{"tab":"API Reference","groups":[{"group":"API Reference","pages":[{"title":"API Overview","description":"In this page you can learn about how to work with Novu's API","href":"/api-reference/overview"},{"title":"API Rate Limiting","href":"/api-reference/rate-limiting"}]},{"group":"Events","pages":[{"openapi":"post /v1/events/trigger","title":"Trigger event","description":"\n Trigger event is the main (and only) way to send notifications to subscribers. The trigger identifier is used to match the particular workflow associated with it. Maximum number of recipients can be 100. Additional information can be passed according the body interface below.\n To prevent duplicate triggers, you can optionally pass a **transactionId** in the request body. If the same **transactionId** is used again, the trigger will be ignored. The retention period depends on your billing tier.","href":"/api-reference/events/trigger-event"},{"openapi":"post /v1/events/trigger/bulk","title":"Bulk trigger event","href":"/api-reference/events/bulk-trigger-event"},{"openapi":"post /v1/events/trigger/broadcast","title":"Broadcast event to all","href":"/api-reference/events/broadcast-event-to-all"},{"openapi":"delete /v1/events/trigger/{transactionId}","title":"Cancel triggered event","href":"/api-reference/events/cancel-triggered-event"}]},{"group":"Subscribers","pages":[{"openapi":"get /v1/subscribers","title":"Get subscribers","href":"/api-reference/subscribers/get-subscribers"},{"openapi":"post /v1/subscribers","title":"Create subscriber","href":"/api-reference/subscribers/create-subscriber"},{"openapi":"post /v1/subscribers/bulk","title":"Bulk create subscribers","href":"/api-reference/subscribers/bulk-create-subscribers"},{"openapi":"get /v1/subscribers/{subscriberId}","title":"Get subscriber","href":"/api-reference/subscribers/get-subscriber"},{"openapi":"put /v1/subscribers/{subscriberId}","title":"Update subscriber","href":"/api-reference/subscribers/update-subscriber"},{"openapi":"delete /v1/subscribers/{subscriberId}","title":"Delete subscriber","href":"/api-reference/subscribers/delete-subscriber"},{"openapi":"put /v1/subscribers/{subscriberId}/credentials","title":"Update provider credentials","href":"/api-reference/subscribers/update-subscriber-credentials"},{"openapi":"delete /v1/subscribers/{subscriberId}/credentials/{providerId}","title":"Delete provider credentials","href":"/api-reference/subscribers/delete-subscriber-credentials-by-providerid"},{"openapi":"patch /v1/subscribers/{subscriberId}/online-status","title":"Update subscriber online status","href":"/api-reference/subscribers/update-subscriber-online-status"},{"openapi":"get /v1/subscribers/{subscriberId}/preferences","title":"Get subscriber preferences","href":"/api-reference/subscribers/get-subscriber-preferences"},{"openapi":"get /v1/subscribers/{subscriberId}/preferences/{level}","title":null,"href":"/api-reference/subscribers/get-subscriber-global-preferences"},{"openapi":"patch /v1/subscribers/{subscriberId}/preferences/{templateId}","title":null,"href":"/api-reference/subscribers/update-subscriber-preference"},{"openapi":"patch /v1/subscribers/{subscriberId}/preferences","title":"Update subscriber global preferences","href":"/api-reference/subscribers/update-subscriber-global-preference"},{"openapi":"get /v1/subscribers/{subscriberId}/notifications/feed","title":"Retrieve subscriber notifications","href":"/api-reference/subscribers/get-in-app-notification-feed-for-a-particular-subscriber"},{"openapi":"get /v1/subscribers/{subscriberId}/notifications/unseen","title":"Retrieve unseen notifications count","href":"/api-reference/subscribers/get-the-unseen-in-app-notifications-count-for-subscribers-feed"},{"openapi":"post /v1/subscribers/{subscriberId}/messages/markAs","title":null,"href":"/api-reference/subscribers/mark-a-subscriber-feed-message-as-seen"},{"openapi":"post /v1/subscribers/{subscriberId}/messages/mark-all","title":"Update all notifications state","href":"/api-reference/subscribers/marks-all-the-subscriber-messages-as-read-unread-seen-or-unseen-optionally-you-can-pass-feed-id-or-array-to-mark-messages-of-a-particular-feed"},{"openapi":"post /v1/subscribers/{subscriberId}/messages/{messageId}/actions/{type}","title":"Update notification action status","href":"/api-reference/subscribers/mark-message-action-as-seen"},{"openapi":"get /v1/subscribers/{subscriberId}/credentials/{providerId}/oauth/callback","title":"Handle providers oauth redirect","href":"/api-reference/subscribers/handle-providers-oauth-redirect"},{"openapi":"get /v1/subscribers/{subscriberId}/credentials/{providerId}/oauth","title":"Handle chat oauth","href":"/api-reference/subscribers/handle-chat-oauth"}]},{"group":"Topics","pages":[{"openapi":"get /v1/topics","title":"Filter topics","href":"/api-reference/topics/filter-topics"},{"openapi":"post /v1/topics","title":"Topic creation","href":"/api-reference/topics/topic-creation"},{"openapi":"post /v1/topics/{topicKey}/subscribers","title":"Subscribers addition","href":"/api-reference/topics/subscribers-addition"},{"openapi":"get /v1/topics/{topicKey}/subscribers/{externalSubscriberId}","title":"Check topic subscriber","href":"/api-reference/topics/check-topic-subscriber"},{"openapi":"post /v1/topics/{topicKey}/subscribers/removal","title":"Subscribers removal","href":"/api-reference/topics/subscribers-removal"},{"openapi":"get /v1/topics/{topicKey}","title":"Get topic","href":"/api-reference/topics/get-topic"},{"openapi":"delete /v1/topics/{topicKey}","title":"Delete topic","href":"/api-reference/topics/delete-topic"},{"openapi":"patch /v1/topics/{topicKey}","title":"Rename a topic","href":"/api-reference/topics/rename-a-topic"}]},{"group":"Notification","pages":[{"openapi":"get /v1/notifications","title":"List all events","href":"/api-reference/notification/get-notifications"},{"openapi":"get /v1/notifications/stats","title":"Get notification statistics","href":"/api-reference/notification/get-notification-statistics"},{"openapi":"get /v1/notifications/graph/stats","title":"Get notification graph statistics","href":"/api-reference/notification/get-notification-graph-statistics"},{"openapi":"get /v1/notifications/{notificationId}","title":"Retrieve an event","href":"/api-reference/notification/get-notification"}]},{"group":"Workflows","pages":[{"openapi":"get /v1/workflows","title":"Get workflows","href":"/api-reference/workflows/get-workflows"},{"openapi":"post /v1/workflows","title":"Create workflow","href":"/api-reference/workflows/create-workflow"},{"openapi":"get /v1/workflows/{workflowIdOrIdentifier}","title":null,"href":"/api-reference/workflows/get-workflow"},{"openapi":"put /v1/workflows/{workflowId}","title":"Update workflow","href":"/api-reference/workflows/update-workflow"},{"openapi":"delete /v1/workflows/{workflowId}","title":"Delete workflow","href":"/api-reference/workflows/delete-workflow"},{"openapi":"put /v1/workflows/{workflowId}/status","title":"Update workflow status","href":"/api-reference/workflows/update-workflow-status"}]},{"group":"Workflow Overrides","pages":[{"openapi":"post /v1/workflow-overrides","title":null,"href":"/api-reference/workflow-overrides/create-workflow-overrides"},{"openapi":"get /v1/workflow-overrides","title":null,"href":"/api-reference/workflow-overrides/get-workflow-overrides"},{"openapi":"get /v1/workflow-overrides/workflows/{workflowId}/tenants/{tenantId}","title":null,"href":"/api-reference/workflow-overrides/get-workflow-override"},{"openapi":"get /v1/workflow-overrides/{overrideId}","title":null,"href":"/api-reference/workflow-overrides/get-workflow-override-by-id"},{"openapi":"put /v1/workflow-overrides/{overrideId}","title":null,"href":"/api-reference/workflow-overrides/update-workflow-override-by-id"},{"openapi":"put /v1/workflow-overrides/workflows/{workflowId}/tenants/{tenantId}","title":null,"href":"/api-reference/workflow-overrides/update-workflow-override"},{"openapi":"delete /v1/workflow-overrides/{overrideId}","title":null,"href":"/api-reference/workflow-overrides/delete-workflow-override"}]},{"group":"Workflow groups","pages":[{"openapi":"get /v1/notification-groups","title":"Get workflow groups","href":"/api-reference/workflow-groups/get-workflow-groups"},{"openapi":"post /v1/notification-groups","title":"Create workflow group","href":"/api-reference/workflow-groups/create-workflow-group"},{"openapi":"get /v1/notification-groups/{id}","title":"Get workflow group","href":"/api-reference/workflow-groups/get-workflow-group"},{"openapi":"delete /v1/notification-groups/{id}","title":"Delete workflow group","href":"/api-reference/workflow-groups/delete-workflow-group"},{"openapi":"patch /v1/notification-groups/{id}","title":"Update workflow group","href":"/api-reference/workflow-groups/update-workflow-group"}]},{"group":"Integrations","pages":[{"openapi":"get /v1/integrations","title":"List all integrations","href":"/api-reference/integrations/get-integrations"},{"openapi":"post /v1/integrations","title":"Create an integration","href":"/api-reference/integrations/create-integration"},{"openapi":"get /v1/integrations/active","title":"List active integrations","href":"/api-reference/integrations/get-active-integrations"},{"openapi":"get /v1/integrations/webhook/provider/{providerId}/status","title":null,"href":"/api-reference/integrations/get-webhook-support-status-for-provider"},{"openapi":"put /v1/integrations/{integrationId}","title":"Update an integration","href":"/api-reference/integrations/update-integration"},{"openapi":"delete /v1/integrations/{integrationId}","title":"Delete an integration","href":"/api-reference/integrations/delete-integration"},{"openapi":"post /v1/integrations/{integrationId}/set-primary","title":"Update integration as primary","href":"/api-reference/integrations/set-integration-as-primary"}]},{"group":"Layouts","pages":[{"openapi":"get /v1/layouts","title":"Filter layouts","href":"/api-reference/layouts/filter-layouts"},{"openapi":"post /v1/layouts","title":"Layout creation","href":"/api-reference/layouts/layout-creation"},{"openapi":"get /v1/layouts/{layoutId}","title":"Get layout","href":"/api-reference/layouts/get-layout"},{"openapi":"delete /v1/layouts/{layoutId}","title":"Delete layout","href":"/api-reference/layouts/delete-layout"},{"openapi":"patch /v1/layouts/{layoutId}","title":"Update a layout","href":"/api-reference/layouts/update-a-layout"},{"openapi":"post /v1/layouts/{layoutId}/default","title":"Set default layout","href":"/api-reference/layouts/set-default-layout"}]},{"group":"Inbound Parse","pages":[{"openapi":"get /v1/inbound-parse/mx/status","title":null,"href":"/api-reference/inbound-parse/validate-the-mx-record-setup-for-the-inbound-parse-functionality"}]},{"group":"Environments","pages":[{"openapi":"get /v1/environments/me","title":"Get current environment","href":"/api-reference/environments/get-current-environment"},{"openapi":"get /v1/environments","title":"List all environments","href":"/api-reference/environments/get-environments"},{"openapi":"get /v1/environments/api-keys","title":"Get api keys","href":"/api-reference/environments/get-api-keys"},{"openapi":"post /v1/environments/api-keys/regenerate","title":"Regenerate api keys","href":"/api-reference/environments/regenerate-api-keys"}]},{"group":"Changes","pages":[{"openapi":"get /v1/changes","title":"Get changes","href":"/api-reference/changes/get-changes"},{"openapi":"get /v1/changes/count","title":"Get changes count","href":"/api-reference/changes/get-changes-count"},{"openapi":"post /v1/changes/bulk/apply","title":"Apply changes","href":"/api-reference/changes/apply-changes"},{"openapi":"post /v1/changes/{changeId}/apply","title":"Apply change","href":"/api-reference/changes/apply-change"}]},{"group":"Execution Details","pages":[{"openapi":"get /v1/execution-details","title":"Get execution details","href":"/api-reference/execution-details/get-execution-details"}]},{"group":"Feeds","pages":[{"openapi":"get /v1/feeds","title":"Get feeds","href":"/api-reference/feeds/get-feeds"},{"openapi":"post /v1/feeds","title":"Create feed","href":"/api-reference/feeds/create-feed"},{"openapi":"delete /v1/feeds/{feedId}","title":"Delete feed","href":"/api-reference/feeds/delete-feed"}]},{"group":"Tenants","pages":[{"openapi":"get /v1/tenants","title":"Get tenants","href":"/api-reference/tenants/get-tenants"},{"openapi":"post /v1/tenants","title":"Create tenant","href":"/api-reference/tenants/create-tenant"},{"openapi":"get /v1/tenants/{identifier}","title":"Get tenant","href":"/api-reference/tenants/get-tenant"},{"openapi":"patch /v1/tenants/{identifier}","title":"Update tenant","href":"/api-reference/tenants/update-tenant"},{"openapi":"delete /v1/tenants/{identifier}","title":"Delete tenant","href":"/api-reference/tenants/delete-tenant"}]},{"group":"Organizations","pages":[{"openapi":"post /v1/organizations","title":"Create an organization","href":"/api-reference/organizations/create-organization"},{"openapi":"get /v1/organizations","title":"Fetch all organizations","href":"/api-reference/organizations/get-all-organizations"},{"openapi":"get /v1/organizations/members","title":"Fetch all members of current organizations","href":"/api-reference/organizations/get-all-members-of-current-organization"},{"openapi":"get /v1/organizations/me","title":"Fetch current organization details","href":"/api-reference/organizations/get-current-organization"},{"openapi":"patch /v1/organizations","title":"Rename organization name","href":"/api-reference/organizations/rename-organization"},{"openapi":"put /v1/organizations/members/{memberId}/roles","title":null,"href":"/api-reference/organizations/update-member-role-to-admin"},{"openapi":"put /v1/organizations/branding","title":"Update organization branding details","href":"/api-reference/organizations/update-organization-branding"},{"openapi":"delete /v1/organizations/members/{memberId}","title":"Remove a member from organization using memberId","href":"/api-reference/organizations/delete-member-from-organization"}]},{"group":"Messages","pages":[{"openapi":"get /v1/messages","title":"List all messages","href":"/api-reference/messages/get-messages"},{"openapi":"delete /v1/messages/{messageId}","title":"Delete a message","href":"/api-reference/messages/delete-message"},{"openapi":"delete /v1/messages/transaction/{transactionId}","title":"Delete messages by transactionId","href":"/api-reference/messages/delete-message-by-transactionid"}]},{"group":"Blueprints","pages":[{"openapi":"get /v1/blueprints/group-by-category","title":null,"href":"/api-reference/get-v1blueprintsgroup-by-category"},{"openapi":"get /v1/blueprints/{templateId}","title":null,"href":"/api-reference/get-v1blueprints"}]}]}]},{"anchor":"Discord Support","icon":"discord","href":"https://discord.gg/novu?ref=docs-instant-help"}]},{"version":"v0.23.0","anchors":[{"anchor":"Documentation","icon":"book-open","pages":[{"title":"Documentation","href":"/getting-started/introduction"}]},{"anchor":"API Reference","icon":"square-terminal","tabs":[{"tab":"API Reference","groups":[{"group":"API Reference","pages":[{"title":"API Overview","description":"In this page you can learn about how to work with Novu's API","href":"/api-reference/overview"},{"title":"API Rate Limiting","href":"/api-reference/rate-limiting"}]},{"group":"Events","pages":[{"openapi":"post /v1/events/trigger","title":"Trigger event","description":"\n Trigger event is the main (and only) way to send notifications to subscribers. The trigger identifier is used to match the particular workflow associated with it. Maximum number of recipients can be 100. Additional information can be passed according the body interface below.\n To prevent duplicate triggers, you can optionally pass a **transactionId** in the request body. If the same **transactionId** is used again, the trigger will be ignored. The retention period depends on your billing tier.","href":"/api-reference/events/trigger-event"},{"openapi":"post /v1/events/trigger/bulk","title":"Bulk trigger event","href":"/api-reference/events/bulk-trigger-event"},{"openapi":"post /v1/events/trigger/broadcast","title":"Broadcast event to all","href":"/api-reference/events/broadcast-event-to-all"},{"openapi":"delete /v1/events/trigger/{transactionId}","title":"Cancel triggered event","href":"/api-reference/events/cancel-triggered-event"}]},{"group":"Subscribers","pages":[{"openapi":"get /v1/subscribers","title":"Get subscribers","href":"/api-reference/subscribers/get-subscribers"},{"openapi":"post /v1/subscribers","title":"Create subscriber","href":"/api-reference/subscribers/create-subscriber"},{"openapi":"post /v1/subscribers/bulk","title":"Bulk create subscribers","href":"/api-reference/subscribers/bulk-create-subscribers"},{"openapi":"get /v1/subscribers/{subscriberId}","title":"Get subscriber","href":"/api-reference/subscribers/get-subscriber"},{"openapi":"put /v1/subscribers/{subscriberId}","title":"Update subscriber","href":"/api-reference/subscribers/update-subscriber"},{"openapi":"delete /v1/subscribers/{subscriberId}","title":"Delete subscriber","href":"/api-reference/subscribers/delete-subscriber"},{"openapi":"put /v1/subscribers/{subscriberId}/credentials","title":"Update provider credentials","href":"/api-reference/subscribers/update-subscriber-credentials"},{"openapi":"delete /v1/subscribers/{subscriberId}/credentials/{providerId}","title":"Delete provider credentials","href":"/api-reference/subscribers/delete-subscriber-credentials-by-providerid"},{"openapi":"patch /v1/subscribers/{subscriberId}/online-status","title":"Update subscriber online status","href":"/api-reference/subscribers/update-subscriber-online-status"},{"openapi":"get /v1/subscribers/{subscriberId}/preferences","title":"Get subscriber preferences","href":"/api-reference/subscribers/get-subscriber-preferences"},{"openapi":"get /v1/subscribers/{subscriberId}/preferences/{level}","title":null,"href":"/api-reference/subscribers/get-subscriber-global-preferences"},{"openapi":"patch /v1/subscribers/{subscriberId}/preferences/{templateId}","title":null,"href":"/api-reference/subscribers/update-subscriber-preference"},{"openapi":"patch /v1/subscribers/{subscriberId}/preferences","title":"Update subscriber global preferences","href":"/api-reference/subscribers/update-subscriber-global-preference"},{"openapi":"get /v1/subscribers/{subscriberId}/notifications/feed","title":"Retrieve subscriber notifications","href":"/api-reference/subscribers/get-in-app-notification-feed-for-a-particular-subscriber"},{"openapi":"get /v1/subscribers/{subscriberId}/notifications/unseen","title":"Retrieve unseen notifications count","href":"/api-reference/subscribers/get-the-unseen-in-app-notifications-count-for-subscribers-feed"},{"openapi":"post /v1/subscribers/{subscriberId}/messages/markAs","title":null,"href":"/api-reference/subscribers/mark-a-subscriber-feed-message-as-seen"},{"openapi":"post /v1/subscribers/{subscriberId}/messages/mark-all","title":"Update all notifications state","href":"/api-reference/subscribers/marks-all-the-subscriber-messages-as-read-unread-seen-or-unseen-optionally-you-can-pass-feed-id-or-array-to-mark-messages-of-a-particular-feed"},{"openapi":"post /v1/subscribers/{subscriberId}/messages/{messageId}/actions/{type}","title":"Update notification action status","href":"/api-reference/subscribers/mark-message-action-as-seen"},{"openapi":"get /v1/subscribers/{subscriberId}/credentials/{providerId}/oauth/callback","title":"Handle providers oauth redirect","href":"/api-reference/subscribers/handle-providers-oauth-redirect"},{"openapi":"get /v1/subscribers/{subscriberId}/credentials/{providerId}/oauth","title":"Handle chat oauth","href":"/api-reference/subscribers/handle-chat-oauth"}]},{"group":"Topics","pages":[{"openapi":"get /v1/topics","title":"Filter topics","href":"/api-reference/topics/filter-topics"},{"openapi":"post /v1/topics","title":"Topic creation","href":"/api-reference/topics/topic-creation"},{"openapi":"post /v1/topics/{topicKey}/subscribers","title":"Subscribers addition","href":"/api-reference/topics/subscribers-addition"},{"openapi":"get /v1/topics/{topicKey}/subscribers/{externalSubscriberId}","title":"Check topic subscriber","href":"/api-reference/topics/check-topic-subscriber"},{"openapi":"post /v1/topics/{topicKey}/subscribers/removal","title":"Subscribers removal","href":"/api-reference/topics/subscribers-removal"},{"openapi":"get /v1/topics/{topicKey}","title":"Get topic","href":"/api-reference/topics/get-topic"},{"openapi":"delete /v1/topics/{topicKey}","title":"Delete topic","href":"/api-reference/topics/delete-topic"},{"openapi":"patch /v1/topics/{topicKey}","title":"Rename a topic","href":"/api-reference/topics/rename-a-topic"}]},{"group":"Notification","pages":[{"openapi":"get /v1/notifications","title":"List all events","href":"/api-reference/notification/get-notifications"},{"openapi":"get /v1/notifications/stats","title":"Get notification statistics","href":"/api-reference/notification/get-notification-statistics"},{"openapi":"get /v1/notifications/graph/stats","title":"Get notification graph statistics","href":"/api-reference/notification/get-notification-graph-statistics"},{"openapi":"get /v1/notifications/{notificationId}","title":"Retrieve an event","href":"/api-reference/notification/get-notification"}]},{"group":"Workflows","pages":[{"openapi":"get /v1/workflows","title":"Get workflows","href":"/api-reference/workflows/get-workflows"},{"openapi":"post /v1/workflows","title":"Create workflow","href":"/api-reference/workflows/create-workflow"},{"openapi":"get /v1/workflows/{workflowIdOrIdentifier}","title":null,"href":"/api-reference/workflows/get-workflow"},{"openapi":"put /v1/workflows/{workflowId}","title":"Update workflow","href":"/api-reference/workflows/update-workflow"},{"openapi":"delete /v1/workflows/{workflowId}","title":"Delete workflow","href":"/api-reference/workflows/delete-workflow"},{"openapi":"put /v1/workflows/{workflowId}/status","title":"Update workflow status","href":"/api-reference/workflows/update-workflow-status"}]},{"group":"Workflow Overrides","pages":[{"openapi":"post /v1/workflow-overrides","title":null,"href":"/api-reference/workflow-overrides/create-workflow-overrides"},{"openapi":"get /v1/workflow-overrides","title":null,"href":"/api-reference/workflow-overrides/get-workflow-overrides"},{"openapi":"get /v1/workflow-overrides/workflows/{workflowId}/tenants/{tenantId}","title":null,"href":"/api-reference/workflow-overrides/get-workflow-override"},{"openapi":"get /v1/workflow-overrides/{overrideId}","title":null,"href":"/api-reference/workflow-overrides/get-workflow-override-by-id"},{"openapi":"put /v1/workflow-overrides/{overrideId}","title":null,"href":"/api-reference/workflow-overrides/update-workflow-override-by-id"},{"openapi":"put /v1/workflow-overrides/workflows/{workflowId}/tenants/{tenantId}","title":null,"href":"/api-reference/workflow-overrides/update-workflow-override"},{"openapi":"delete /v1/workflow-overrides/{overrideId}","title":null,"href":"/api-reference/workflow-overrides/delete-workflow-override"}]},{"group":"Workflow groups","pages":[{"openapi":"get /v1/notification-groups","title":"Get workflow groups","href":"/api-reference/workflow-groups/get-workflow-groups"},{"openapi":"post /v1/notification-groups","title":"Create workflow group","href":"/api-reference/workflow-groups/create-workflow-group"},{"openapi":"get /v1/notification-groups/{id}","title":"Get workflow group","href":"/api-reference/workflow-groups/get-workflow-group"},{"openapi":"delete /v1/notification-groups/{id}","title":"Delete workflow group","href":"/api-reference/workflow-groups/delete-workflow-group"},{"openapi":"patch /v1/notification-groups/{id}","title":"Update workflow group","href":"/api-reference/workflow-groups/update-workflow-group"}]},{"group":"Integrations","pages":[{"openapi":"get /v1/integrations","title":"List all integrations","href":"/api-reference/integrations/get-integrations"},{"openapi":"post /v1/integrations","title":"Create an integration","href":"/api-reference/integrations/create-integration"},{"openapi":"get /v1/integrations/active","title":"List active integrations","href":"/api-reference/integrations/get-active-integrations"},{"openapi":"get /v1/integrations/webhook/provider/{providerId}/status","title":null,"href":"/api-reference/integrations/get-webhook-support-status-for-provider"},{"openapi":"put /v1/integrations/{integrationId}","title":"Update an integration","href":"/api-reference/integrations/update-integration"},{"openapi":"delete /v1/integrations/{integrationId}","title":"Delete an integration","href":"/api-reference/integrations/delete-integration"},{"openapi":"post /v1/integrations/{integrationId}/set-primary","title":"Update integration as primary","href":"/api-reference/integrations/set-integration-as-primary"}]},{"group":"Layouts","pages":[{"openapi":"get /v1/layouts","title":"Filter layouts","href":"/api-reference/layouts/filter-layouts"},{"openapi":"post /v1/layouts","title":"Layout creation","href":"/api-reference/layouts/layout-creation"},{"openapi":"get /v1/layouts/{layoutId}","title":"Get layout","href":"/api-reference/layouts/get-layout"},{"openapi":"delete /v1/layouts/{layoutId}","title":"Delete layout","href":"/api-reference/layouts/delete-layout"},{"openapi":"patch /v1/layouts/{layoutId}","title":"Update a layout","href":"/api-reference/layouts/update-a-layout"},{"openapi":"post /v1/layouts/{layoutId}/default","title":"Set default layout","href":"/api-reference/layouts/set-default-layout"}]},{"group":"Inbound Parse","pages":[{"openapi":"get /v1/inbound-parse/mx/status","title":null,"href":"/api-reference/inbound-parse/validate-the-mx-record-setup-for-the-inbound-parse-functionality"}]},{"group":"Environments","pages":[{"openapi":"get /v1/environments/me","title":"Get current environment","href":"/api-reference/environments/get-current-environment"},{"openapi":"get /v1/environments","title":"List all environments","href":"/api-reference/environments/get-environments"},{"openapi":"get /v1/environments/api-keys","title":"Get api keys","href":"/api-reference/environments/get-api-keys"},{"openapi":"post /v1/environments/api-keys/regenerate","title":"Regenerate api keys","href":"/api-reference/environments/regenerate-api-keys"}]},{"group":"Changes","pages":[{"openapi":"get /v1/changes","title":"Get changes","href":"/api-reference/changes/get-changes"},{"openapi":"get /v1/changes/count","title":"Get changes count","href":"/api-reference/changes/get-changes-count"},{"openapi":"post /v1/changes/bulk/apply","title":"Apply changes","href":"/api-reference/changes/apply-changes"},{"openapi":"post /v1/changes/{changeId}/apply","title":"Apply change","href":"/api-reference/changes/apply-change"}]},{"group":"Execution Details","pages":[{"openapi":"get /v1/execution-details","title":"Get execution details","href":"/api-reference/execution-details/get-execution-details"}]},{"group":"Feeds","pages":[{"openapi":"get /v1/feeds","title":"Get feeds","href":"/api-reference/feeds/get-feeds"},{"openapi":"post /v1/feeds","title":"Create feed","href":"/api-reference/feeds/create-feed"},{"openapi":"delete /v1/feeds/{feedId}","title":"Delete feed","href":"/api-reference/feeds/delete-feed"}]},{"group":"Tenants","pages":[{"openapi":"get /v1/tenants","title":"Get tenants","href":"/api-reference/tenants/get-tenants"},{"openapi":"post /v1/tenants","title":"Create tenant","href":"/api-reference/tenants/create-tenant"},{"openapi":"get /v1/tenants/{identifier}","title":"Get tenant","href":"/api-reference/tenants/get-tenant"},{"openapi":"patch /v1/tenants/{identifier}","title":"Update tenant","href":"/api-reference/tenants/update-tenant"},{"openapi":"delete /v1/tenants/{identifier}","title":"Delete tenant","href":"/api-reference/tenants/delete-tenant"}]},{"group":"Organizations","pages":[{"openapi":"post /v1/organizations","title":"Create an organization","href":"/api-reference/organizations/create-organization"},{"openapi":"get /v1/organizations","title":"Fetch all organizations","href":"/api-reference/organizations/get-all-organizations"},{"openapi":"get /v1/organizations/members","title":"Fetch all members of current organizations","href":"/api-reference/organizations/get-all-members-of-current-organization"},{"openapi":"get /v1/organizations/me","title":"Fetch current organization details","href":"/api-reference/organizations/get-current-organization"},{"openapi":"patch /v1/organizations","title":"Rename organization name","href":"/api-reference/organizations/rename-organization"},{"openapi":"put /v1/organizations/members/{memberId}/roles","title":null,"href":"/api-reference/organizations/update-member-role-to-admin"},{"openapi":"put /v1/organizations/branding","title":"Update organization branding details","href":"/api-reference/organizations/update-organization-branding"},{"openapi":"delete /v1/organizations/members/{memberId}","title":"Remove a member from organization using memberId","href":"/api-reference/organizations/delete-member-from-organization"}]},{"group":"Messages","pages":[{"openapi":"get /v1/messages","title":"List all messages","href":"/api-reference/messages/get-messages"},{"openapi":"delete /v1/messages/{messageId}","title":"Delete a message","href":"/api-reference/messages/delete-message"},{"openapi":"delete /v1/messages/transaction/{transactionId}","title":"Delete messages by transactionId","href":"/api-reference/messages/delete-message-by-transactionid"}]},{"group":"Blueprints","pages":[{"openapi":"get /v1/blueprints/group-by-category","title":null,"href":"/api-reference/get-v1blueprintsgroup-by-category"},{"openapi":"get /v1/blueprints/{templateId}","title":null,"href":"/api-reference/get-v1blueprints"}]}]}]},{"anchor":"Discord Support","icon":"discord","href":"https://discord.gg/novu?ref=docs-instant-help"}]},{"version":"v0.22.0","anchors":[{"anchor":"Documentation","icon":"book-open","pages":[{"title":"Documentation","href":"/getting-started/introduction"}]},{"anchor":"API Reference","icon":"square-terminal","tabs":[{"tab":"API Reference","groups":[{"group":"API Reference","pages":[{"title":"API Overview","description":"In this page you can learn about how to work with Novu's API","href":"/api-reference/overview"},{"title":"API Rate Limiting","href":"/api-reference/rate-limiting"}]},{"group":"Events","pages":[{"openapi":"post /v1/events/trigger","title":"Trigger event","description":"\n Trigger event is the main (and only) way to send notifications to subscribers. The trigger identifier is used to match the particular workflow associated with it. Maximum number of recipients can be 100. Additional information can be passed according the body interface below.\n To prevent duplicate triggers, you can optionally pass a **transactionId** in the request body. If the same **transactionId** is used again, the trigger will be ignored. The retention period depends on your billing tier.","href":"/api-reference/events/trigger-event"},{"openapi":"post /v1/events/trigger/bulk","title":"Bulk trigger event","href":"/api-reference/events/bulk-trigger-event"},{"openapi":"post /v1/events/trigger/broadcast","title":"Broadcast event to all","href":"/api-reference/events/broadcast-event-to-all"},{"openapi":"delete /v1/events/trigger/{transactionId}","title":"Cancel triggered event","href":"/api-reference/events/cancel-triggered-event"}]},{"group":"Subscribers","pages":[{"openapi":"get /v1/subscribers","title":"Get subscribers","href":"/api-reference/subscribers/get-subscribers"},{"openapi":"post /v1/subscribers","title":"Create subscriber","href":"/api-reference/subscribers/create-subscriber"},{"openapi":"post /v1/subscribers/bulk","title":"Bulk create subscribers","href":"/api-reference/subscribers/bulk-create-subscribers"},{"openapi":"get /v1/subscribers/{subscriberId}","title":"Get subscriber","href":"/api-reference/subscribers/get-subscriber"},{"openapi":"put /v1/subscribers/{subscriberId}","title":"Update subscriber","href":"/api-reference/subscribers/update-subscriber"},{"openapi":"delete /v1/subscribers/{subscriberId}","title":"Delete subscriber","href":"/api-reference/subscribers/delete-subscriber"},{"openapi":"put /v1/subscribers/{subscriberId}/credentials","title":"Update provider credentials","href":"/api-reference/subscribers/update-subscriber-credentials"},{"openapi":"delete /v1/subscribers/{subscriberId}/credentials/{providerId}","title":"Delete provider credentials","href":"/api-reference/subscribers/delete-subscriber-credentials-by-providerid"},{"openapi":"patch /v1/subscribers/{subscriberId}/online-status","title":"Update subscriber online status","href":"/api-reference/subscribers/update-subscriber-online-status"},{"openapi":"get /v1/subscribers/{subscriberId}/preferences","title":"Get subscriber preferences","href":"/api-reference/subscribers/get-subscriber-preferences"},{"openapi":"get /v1/subscribers/{subscriberId}/preferences/{level}","title":null,"href":"/api-reference/subscribers/get-subscriber-global-preferences"},{"openapi":"patch /v1/subscribers/{subscriberId}/preferences/{templateId}","title":null,"href":"/api-reference/subscribers/update-subscriber-preference"},{"openapi":"patch /v1/subscribers/{subscriberId}/preferences","title":"Update subscriber global preferences","href":"/api-reference/subscribers/update-subscriber-global-preference"},{"openapi":"get /v1/subscribers/{subscriberId}/notifications/feed","title":"Retrieve subscriber notifications","href":"/api-reference/subscribers/get-in-app-notification-feed-for-a-particular-subscriber"},{"openapi":"get /v1/subscribers/{subscriberId}/notifications/unseen","title":"Retrieve unseen notifications count","href":"/api-reference/subscribers/get-the-unseen-in-app-notifications-count-for-subscribers-feed"},{"openapi":"post /v1/subscribers/{subscriberId}/messages/markAs","title":null,"href":"/api-reference/subscribers/mark-a-subscriber-feed-message-as-seen"},{"openapi":"post /v1/subscribers/{subscriberId}/messages/mark-all","title":"Update all notifications state","href":"/api-reference/subscribers/marks-all-the-subscriber-messages-as-read-unread-seen-or-unseen-optionally-you-can-pass-feed-id-or-array-to-mark-messages-of-a-particular-feed"},{"openapi":"post /v1/subscribers/{subscriberId}/messages/{messageId}/actions/{type}","title":"Update notification action status","href":"/api-reference/subscribers/mark-message-action-as-seen"},{"openapi":"get /v1/subscribers/{subscriberId}/credentials/{providerId}/oauth/callback","title":"Handle providers oauth redirect","href":"/api-reference/subscribers/handle-providers-oauth-redirect"},{"openapi":"get /v1/subscribers/{subscriberId}/credentials/{providerId}/oauth","title":"Handle chat oauth","href":"/api-reference/subscribers/handle-chat-oauth"}]},{"group":"Topics","pages":[{"openapi":"get /v1/topics","title":"Filter topics","href":"/api-reference/topics/filter-topics"},{"openapi":"post /v1/topics","title":"Topic creation","href":"/api-reference/topics/topic-creation"},{"openapi":"post /v1/topics/{topicKey}/subscribers","title":"Subscribers addition","href":"/api-reference/topics/subscribers-addition"},{"openapi":"get /v1/topics/{topicKey}/subscribers/{externalSubscriberId}","title":"Check topic subscriber","href":"/api-reference/topics/check-topic-subscriber"},{"openapi":"post /v1/topics/{topicKey}/subscribers/removal","title":"Subscribers removal","href":"/api-reference/topics/subscribers-removal"},{"openapi":"get /v1/topics/{topicKey}","title":"Get topic","href":"/api-reference/topics/get-topic"},{"openapi":"delete /v1/topics/{topicKey}","title":"Delete topic","href":"/api-reference/topics/delete-topic"},{"openapi":"patch /v1/topics/{topicKey}","title":"Rename a topic","href":"/api-reference/topics/rename-a-topic"}]},{"group":"Notification","pages":[{"openapi":"get /v1/notifications","title":"List all events","href":"/api-reference/notification/get-notifications"},{"openapi":"get /v1/notifications/stats","title":"Get notification statistics","href":"/api-reference/notification/get-notification-statistics"},{"openapi":"get /v1/notifications/graph/stats","title":"Get notification graph statistics","href":"/api-reference/notification/get-notification-graph-statistics"},{"openapi":"get /v1/notifications/{notificationId}","title":"Retrieve an event","href":"/api-reference/notification/get-notification"}]},{"group":"Workflows","pages":[{"openapi":"get /v1/workflows","title":"Get workflows","href":"/api-reference/workflows/get-workflows"},{"openapi":"post /v1/workflows","title":"Create workflow","href":"/api-reference/workflows/create-workflow"},{"openapi":"get /v1/workflows/{workflowIdOrIdentifier}","title":null,"href":"/api-reference/workflows/get-workflow"},{"openapi":"put /v1/workflows/{workflowId}","title":"Update workflow","href":"/api-reference/workflows/update-workflow"},{"openapi":"delete /v1/workflows/{workflowId}","title":"Delete workflow","href":"/api-reference/workflows/delete-workflow"},{"openapi":"put /v1/workflows/{workflowId}/status","title":"Update workflow status","href":"/api-reference/workflows/update-workflow-status"}]},{"group":"Workflow Overrides","pages":[{"openapi":"post /v1/workflow-overrides","title":null,"href":"/api-reference/workflow-overrides/create-workflow-overrides"},{"openapi":"get /v1/workflow-overrides","title":null,"href":"/api-reference/workflow-overrides/get-workflow-overrides"},{"openapi":"get /v1/workflow-overrides/workflows/{workflowId}/tenants/{tenantId}","title":null,"href":"/api-reference/workflow-overrides/get-workflow-override"},{"openapi":"get /v1/workflow-overrides/{overrideId}","title":null,"href":"/api-reference/workflow-overrides/get-workflow-override-by-id"},{"openapi":"put /v1/workflow-overrides/{overrideId}","title":null,"href":"/api-reference/workflow-overrides/update-workflow-override-by-id"},{"openapi":"put /v1/workflow-overrides/workflows/{workflowId}/tenants/{tenantId}","title":null,"href":"/api-reference/workflow-overrides/update-workflow-override"},{"openapi":"delete /v1/workflow-overrides/{overrideId}","title":null,"href":"/api-reference/workflow-overrides/delete-workflow-override"}]},{"group":"Workflow groups","pages":[{"openapi":"get /v1/notification-groups","title":"Get workflow groups","href":"/api-reference/workflow-groups/get-workflow-groups"},{"openapi":"post /v1/notification-groups","title":"Create workflow group","href":"/api-reference/workflow-groups/create-workflow-group"},{"openapi":"get /v1/notification-groups/{id}","title":"Get workflow group","href":"/api-reference/workflow-groups/get-workflow-group"},{"openapi":"delete /v1/notification-groups/{id}","title":"Delete workflow group","href":"/api-reference/workflow-groups/delete-workflow-group"},{"openapi":"patch /v1/notification-groups/{id}","title":"Update workflow group","href":"/api-reference/workflow-groups/update-workflow-group"}]},{"group":"Integrations","pages":[{"openapi":"get /v1/integrations","title":"List all integrations","href":"/api-reference/integrations/get-integrations"},{"openapi":"post /v1/integrations","title":"Create an integration","href":"/api-reference/integrations/create-integration"},{"openapi":"get /v1/integrations/active","title":"List active integrations","href":"/api-reference/integrations/get-active-integrations"},{"openapi":"get /v1/integrations/webhook/provider/{providerId}/status","title":null,"href":"/api-reference/integrations/get-webhook-support-status-for-provider"},{"openapi":"put /v1/integrations/{integrationId}","title":"Update an integration","href":"/api-reference/integrations/update-integration"},{"openapi":"delete /v1/integrations/{integrationId}","title":"Delete an integration","href":"/api-reference/integrations/delete-integration"},{"openapi":"post /v1/integrations/{integrationId}/set-primary","title":"Update integration as primary","href":"/api-reference/integrations/set-integration-as-primary"}]},{"group":"Layouts","pages":[{"openapi":"get /v1/layouts","title":"Filter layouts","href":"/api-reference/layouts/filter-layouts"},{"openapi":"post /v1/layouts","title":"Layout creation","href":"/api-reference/layouts/layout-creation"},{"openapi":"get /v1/layouts/{layoutId}","title":"Get layout","href":"/api-reference/layouts/get-layout"},{"openapi":"delete /v1/layouts/{layoutId}","title":"Delete layout","href":"/api-reference/layouts/delete-layout"},{"openapi":"patch /v1/layouts/{layoutId}","title":"Update a layout","href":"/api-reference/layouts/update-a-layout"},{"openapi":"post /v1/layouts/{layoutId}/default","title":"Set default layout","href":"/api-reference/layouts/set-default-layout"}]},{"group":"Inbound Parse","pages":[{"openapi":"get /v1/inbound-parse/mx/status","title":null,"href":"/api-reference/inbound-parse/validate-the-mx-record-setup-for-the-inbound-parse-functionality"}]},{"group":"Environments","pages":[{"openapi":"get /v1/environments/me","title":"Get current environment","href":"/api-reference/environments/get-current-environment"},{"openapi":"get /v1/environments","title":"List all environments","href":"/api-reference/environments/get-environments"},{"openapi":"get /v1/environments/api-keys","title":"Get api keys","href":"/api-reference/environments/get-api-keys"},{"openapi":"post /v1/environments/api-keys/regenerate","title":"Regenerate api keys","href":"/api-reference/environments/regenerate-api-keys"}]},{"group":"Changes","pages":[{"openapi":"get /v1/changes","title":"Get changes","href":"/api-reference/changes/get-changes"},{"openapi":"get /v1/changes/count","title":"Get changes count","href":"/api-reference/changes/get-changes-count"},{"openapi":"post /v1/changes/bulk/apply","title":"Apply changes","href":"/api-reference/changes/apply-changes"},{"openapi":"post /v1/changes/{changeId}/apply","title":"Apply change","href":"/api-reference/changes/apply-change"}]},{"group":"Execution Details","pages":[{"openapi":"get /v1/execution-details","title":"Get execution details","href":"/api-reference/execution-details/get-execution-details"}]},{"group":"Feeds","pages":[{"openapi":"get /v1/feeds","title":"Get feeds","href":"/api-reference/feeds/get-feeds"},{"openapi":"post /v1/feeds","title":"Create feed","href":"/api-reference/feeds/create-feed"},{"openapi":"delete /v1/feeds/{feedId}","title":"Delete feed","href":"/api-reference/feeds/delete-feed"}]},{"group":"Tenants","pages":[{"openapi":"get /v1/tenants","title":"Get tenants","href":"/api-reference/tenants/get-tenants"},{"openapi":"post /v1/tenants","title":"Create tenant","href":"/api-reference/tenants/create-tenant"},{"openapi":"get /v1/tenants/{identifier}","title":"Get tenant","href":"/api-reference/tenants/get-tenant"},{"openapi":"patch /v1/tenants/{identifier}","title":"Update tenant","href":"/api-reference/tenants/update-tenant"},{"openapi":"delete /v1/tenants/{identifier}","title":"Delete tenant","href":"/api-reference/tenants/delete-tenant"}]},{"group":"Organizations","pages":[{"openapi":"post /v1/organizations","title":"Create an organization","href":"/api-reference/organizations/create-organization"},{"openapi":"get /v1/organizations","title":"Fetch all organizations","href":"/api-reference/organizations/get-all-organizations"},{"openapi":"get /v1/organizations/members","title":"Fetch all members of current organizations","href":"/api-reference/organizations/get-all-members-of-current-organization"},{"openapi":"get /v1/organizations/me","title":"Fetch current organization details","href":"/api-reference/organizations/get-current-organization"},{"openapi":"patch /v1/organizations","title":"Rename organization name","href":"/api-reference/organizations/rename-organization"},{"openapi":"put /v1/organizations/members/{memberId}/roles","title":null,"href":"/api-reference/organizations/update-member-role-to-admin"},{"openapi":"put /v1/organizations/branding","title":"Update organization branding details","href":"/api-reference/organizations/update-organization-branding"},{"openapi":"delete /v1/organizations/members/{memberId}","title":"Remove a member from organization using memberId","href":"/api-reference/organizations/delete-member-from-organization"}]},{"group":"Messages","pages":[{"openapi":"get /v1/messages","title":"List all messages","href":"/api-reference/messages/get-messages"},{"openapi":"delete /v1/messages/{messageId}","title":"Delete a message","href":"/api-reference/messages/delete-message"},{"openapi":"delete /v1/messages/transaction/{transactionId}","title":"Delete messages by transactionId","href":"/api-reference/messages/delete-message-by-transactionid"}]},{"group":"Blueprints","pages":[{"openapi":"get /v1/blueprints/group-by-category","title":null,"href":"/api-reference/get-v1blueprintsgroup-by-category"},{"openapi":"get /v1/blueprints/{templateId}","title":null,"href":"/api-reference/get-v1blueprints"}]}]}]},{"anchor":"Discord Support","icon":"discord","href":"https://discord.gg/novu?ref=docs-instant-help"}]},{"version":"v0.21.0","anchors":[{"anchor":"Documentation","icon":"book-open","pages":[{"title":"Documentation","href":"/getting-started/introduction"}]},{"anchor":"API Reference","icon":"square-terminal","tabs":[{"tab":"API Reference","groups":[{"group":"API Reference","pages":[{"title":"API Overview","description":"In this page you can learn about how to work with Novu's API","href":"/api-reference/overview"},{"title":"API Rate Limiting","href":"/api-reference/rate-limiting"}]},{"group":"Events","pages":[{"openapi":"post /v1/events/trigger","title":"Trigger event","description":"\n Trigger event is the main (and only) way to send notifications to subscribers. The trigger identifier is used to match the particular workflow associated with it. Maximum number of recipients can be 100. Additional information can be passed according the body interface below.\n To prevent duplicate triggers, you can optionally pass a **transactionId** in the request body. If the same **transactionId** is used again, the trigger will be ignored. The retention period depends on your billing tier.","href":"/api-reference/events/trigger-event"},{"openapi":"post /v1/events/trigger/bulk","title":"Bulk trigger event","href":"/api-reference/events/bulk-trigger-event"},{"openapi":"post /v1/events/trigger/broadcast","title":"Broadcast event to all","href":"/api-reference/events/broadcast-event-to-all"},{"openapi":"delete /v1/events/trigger/{transactionId}","title":"Cancel triggered event","href":"/api-reference/events/cancel-triggered-event"}]},{"group":"Subscribers","pages":[{"openapi":"get /v1/subscribers","title":"Get subscribers","href":"/api-reference/subscribers/get-subscribers"},{"openapi":"post /v1/subscribers","title":"Create subscriber","href":"/api-reference/subscribers/create-subscriber"},{"openapi":"post /v1/subscribers/bulk","title":"Bulk create subscribers","href":"/api-reference/subscribers/bulk-create-subscribers"},{"openapi":"get /v1/subscribers/{subscriberId}","title":"Get subscriber","href":"/api-reference/subscribers/get-subscriber"},{"openapi":"put /v1/subscribers/{subscriberId}","title":"Update subscriber","href":"/api-reference/subscribers/update-subscriber"},{"openapi":"delete /v1/subscribers/{subscriberId}","title":"Delete subscriber","href":"/api-reference/subscribers/delete-subscriber"},{"openapi":"put /v1/subscribers/{subscriberId}/credentials","title":"Update provider credentials","href":"/api-reference/subscribers/update-subscriber-credentials"},{"openapi":"delete /v1/subscribers/{subscriberId}/credentials/{providerId}","title":"Delete provider credentials","href":"/api-reference/subscribers/delete-subscriber-credentials-by-providerid"},{"openapi":"patch /v1/subscribers/{subscriberId}/online-status","title":"Update subscriber online status","href":"/api-reference/subscribers/update-subscriber-online-status"},{"openapi":"get /v1/subscribers/{subscriberId}/preferences","title":"Get subscriber preferences","href":"/api-reference/subscribers/get-subscriber-preferences"},{"openapi":"get /v1/subscribers/{subscriberId}/preferences/{level}","title":null,"href":"/api-reference/subscribers/get-subscriber-global-preferences"},{"openapi":"patch /v1/subscribers/{subscriberId}/preferences/{templateId}","title":null,"href":"/api-reference/subscribers/update-subscriber-preference"},{"openapi":"patch /v1/subscribers/{subscriberId}/preferences","title":"Update subscriber global preferences","href":"/api-reference/subscribers/update-subscriber-global-preference"},{"openapi":"get /v1/subscribers/{subscriberId}/notifications/feed","title":"Retrieve subscriber notifications","href":"/api-reference/subscribers/get-in-app-notification-feed-for-a-particular-subscriber"},{"openapi":"get /v1/subscribers/{subscriberId}/notifications/unseen","title":"Retrieve unseen notifications count","href":"/api-reference/subscribers/get-the-unseen-in-app-notifications-count-for-subscribers-feed"},{"openapi":"post /v1/subscribers/{subscriberId}/messages/markAs","title":null,"href":"/api-reference/subscribers/mark-a-subscriber-feed-message-as-seen"},{"openapi":"post /v1/subscribers/{subscriberId}/messages/mark-all","title":"Update all notifications state","href":"/api-reference/subscribers/marks-all-the-subscriber-messages-as-read-unread-seen-or-unseen-optionally-you-can-pass-feed-id-or-array-to-mark-messages-of-a-particular-feed"},{"openapi":"post /v1/subscribers/{subscriberId}/messages/{messageId}/actions/{type}","title":"Update notification action status","href":"/api-reference/subscribers/mark-message-action-as-seen"},{"openapi":"get /v1/subscribers/{subscriberId}/credentials/{providerId}/oauth/callback","title":"Handle providers oauth redirect","href":"/api-reference/subscribers/handle-providers-oauth-redirect"},{"openapi":"get /v1/subscribers/{subscriberId}/credentials/{providerId}/oauth","title":"Handle chat oauth","href":"/api-reference/subscribers/handle-chat-oauth"}]},{"group":"Topics","pages":[{"openapi":"get /v1/topics","title":"Filter topics","href":"/api-reference/topics/filter-topics"},{"openapi":"post /v1/topics","title":"Topic creation","href":"/api-reference/topics/topic-creation"},{"openapi":"post /v1/topics/{topicKey}/subscribers","title":"Subscribers addition","href":"/api-reference/topics/subscribers-addition"},{"openapi":"get /v1/topics/{topicKey}/subscribers/{externalSubscriberId}","title":"Check topic subscriber","href":"/api-reference/topics/check-topic-subscriber"},{"openapi":"post /v1/topics/{topicKey}/subscribers/removal","title":"Subscribers removal","href":"/api-reference/topics/subscribers-removal"},{"openapi":"get /v1/topics/{topicKey}","title":"Get topic","href":"/api-reference/topics/get-topic"},{"openapi":"delete /v1/topics/{topicKey}","title":"Delete topic","href":"/api-reference/topics/delete-topic"},{"openapi":"patch /v1/topics/{topicKey}","title":"Rename a topic","href":"/api-reference/topics/rename-a-topic"}]},{"group":"Notification","pages":[{"openapi":"get /v1/notifications","title":"List all events","href":"/api-reference/notification/get-notifications"},{"openapi":"get /v1/notifications/stats","title":"Get notification statistics","href":"/api-reference/notification/get-notification-statistics"},{"openapi":"get /v1/notifications/graph/stats","title":"Get notification graph statistics","href":"/api-reference/notification/get-notification-graph-statistics"},{"openapi":"get /v1/notifications/{notificationId}","title":"Retrieve an event","href":"/api-reference/notification/get-notification"}]},{"group":"Workflows","pages":[{"openapi":"get /v1/workflows","title":"Get workflows","href":"/api-reference/workflows/get-workflows"},{"openapi":"post /v1/workflows","title":"Create workflow","href":"/api-reference/workflows/create-workflow"},{"openapi":"get /v1/workflows/{workflowIdOrIdentifier}","title":null,"href":"/api-reference/workflows/get-workflow"},{"openapi":"put /v1/workflows/{workflowId}","title":"Update workflow","href":"/api-reference/workflows/update-workflow"},{"openapi":"delete /v1/workflows/{workflowId}","title":"Delete workflow","href":"/api-reference/workflows/delete-workflow"},{"openapi":"put /v1/workflows/{workflowId}/status","title":"Update workflow status","href":"/api-reference/workflows/update-workflow-status"}]},{"group":"Workflow Overrides","pages":[{"openapi":"post /v1/workflow-overrides","title":null,"href":"/api-reference/workflow-overrides/create-workflow-overrides"},{"openapi":"get /v1/workflow-overrides","title":null,"href":"/api-reference/workflow-overrides/get-workflow-overrides"},{"openapi":"get /v1/workflow-overrides/workflows/{workflowId}/tenants/{tenantId}","title":null,"href":"/api-reference/workflow-overrides/get-workflow-override"},{"openapi":"get /v1/workflow-overrides/{overrideId}","title":null,"href":"/api-reference/workflow-overrides/get-workflow-override-by-id"},{"openapi":"put /v1/workflow-overrides/{overrideId}","title":null,"href":"/api-reference/workflow-overrides/update-workflow-override-by-id"},{"openapi":"put /v1/workflow-overrides/workflows/{workflowId}/tenants/{tenantId}","title":null,"href":"/api-reference/workflow-overrides/update-workflow-override"},{"openapi":"delete /v1/workflow-overrides/{overrideId}","title":null,"href":"/api-reference/workflow-overrides/delete-workflow-override"}]},{"group":"Workflow groups","pages":[{"openapi":"get /v1/notification-groups","title":"Get workflow groups","href":"/api-reference/workflow-groups/get-workflow-groups"},{"openapi":"post /v1/notification-groups","title":"Create workflow group","href":"/api-reference/workflow-groups/create-workflow-group"},{"openapi":"get /v1/notification-groups/{id}","title":"Get workflow group","href":"/api-reference/workflow-groups/get-workflow-group"},{"openapi":"delete /v1/notification-groups/{id}","title":"Delete workflow group","href":"/api-reference/workflow-groups/delete-workflow-group"},{"openapi":"patch /v1/notification-groups/{id}","title":"Update workflow group","href":"/api-reference/workflow-groups/update-workflow-group"}]},{"group":"Integrations","pages":[{"openapi":"get /v1/integrations","title":"List all integrations","href":"/api-reference/integrations/get-integrations"},{"openapi":"post /v1/integrations","title":"Create an integration","href":"/api-reference/integrations/create-integration"},{"openapi":"get /v1/integrations/active","title":"List active integrations","href":"/api-reference/integrations/get-active-integrations"},{"openapi":"get /v1/integrations/webhook/provider/{providerId}/status","title":null,"href":"/api-reference/integrations/get-webhook-support-status-for-provider"},{"openapi":"put /v1/integrations/{integrationId}","title":"Update an integration","href":"/api-reference/integrations/update-integration"},{"openapi":"delete /v1/integrations/{integrationId}","title":"Delete an integration","href":"/api-reference/integrations/delete-integration"},{"openapi":"post /v1/integrations/{integrationId}/set-primary","title":"Update integration as primary","href":"/api-reference/integrations/set-integration-as-primary"}]},{"group":"Layouts","pages":[{"openapi":"get /v1/layouts","title":"Filter layouts","href":"/api-reference/layouts/filter-layouts"},{"openapi":"post /v1/layouts","title":"Layout creation","href":"/api-reference/layouts/layout-creation"},{"openapi":"get /v1/layouts/{layoutId}","title":"Get layout","href":"/api-reference/layouts/get-layout"},{"openapi":"delete /v1/layouts/{layoutId}","title":"Delete layout","href":"/api-reference/layouts/delete-layout"},{"openapi":"patch /v1/layouts/{layoutId}","title":"Update a layout","href":"/api-reference/layouts/update-a-layout"},{"openapi":"post /v1/layouts/{layoutId}/default","title":"Set default layout","href":"/api-reference/layouts/set-default-layout"}]},{"group":"Inbound Parse","pages":[{"openapi":"get /v1/inbound-parse/mx/status","title":null,"href":"/api-reference/inbound-parse/validate-the-mx-record-setup-for-the-inbound-parse-functionality"}]},{"group":"Environments","pages":[{"openapi":"get /v1/environments/me","title":"Get current environment","href":"/api-reference/environments/get-current-environment"},{"openapi":"get /v1/environments","title":"List all environments","href":"/api-reference/environments/get-environments"},{"openapi":"get /v1/environments/api-keys","title":"Get api keys","href":"/api-reference/environments/get-api-keys"},{"openapi":"post /v1/environments/api-keys/regenerate","title":"Regenerate api keys","href":"/api-reference/environments/regenerate-api-keys"}]},{"group":"Changes","pages":[{"openapi":"get /v1/changes","title":"Get changes","href":"/api-reference/changes/get-changes"},{"openapi":"get /v1/changes/count","title":"Get changes count","href":"/api-reference/changes/get-changes-count"},{"openapi":"post /v1/changes/bulk/apply","title":"Apply changes","href":"/api-reference/changes/apply-changes"},{"openapi":"post /v1/changes/{changeId}/apply","title":"Apply change","href":"/api-reference/changes/apply-change"}]},{"group":"Execution Details","pages":[{"openapi":"get /v1/execution-details","title":"Get execution details","href":"/api-reference/execution-details/get-execution-details"}]},{"group":"Feeds","pages":[{"openapi":"get /v1/feeds","title":"Get feeds","href":"/api-reference/feeds/get-feeds"},{"openapi":"post /v1/feeds","title":"Create feed","href":"/api-reference/feeds/create-feed"},{"openapi":"delete /v1/feeds/{feedId}","title":"Delete feed","href":"/api-reference/feeds/delete-feed"}]},{"group":"Tenants","pages":[{"openapi":"get /v1/tenants","title":"Get tenants","href":"/api-reference/tenants/get-tenants"},{"openapi":"post /v1/tenants","title":"Create tenant","href":"/api-reference/tenants/create-tenant"},{"openapi":"get /v1/tenants/{identifier}","title":"Get tenant","href":"/api-reference/tenants/get-tenant"},{"openapi":"patch /v1/tenants/{identifier}","title":"Update tenant","href":"/api-reference/tenants/update-tenant"},{"openapi":"delete /v1/tenants/{identifier}","title":"Delete tenant","href":"/api-reference/tenants/delete-tenant"}]},{"group":"Organizations","pages":[{"openapi":"post /v1/organizations","title":"Create an organization","href":"/api-reference/organizations/create-organization"},{"openapi":"get /v1/organizations","title":"Fetch all organizations","href":"/api-reference/organizations/get-all-organizations"},{"openapi":"get /v1/organizations/members","title":"Fetch all members of current organizations","href":"/api-reference/organizations/get-all-members-of-current-organization"},{"openapi":"get /v1/organizations/me","title":"Fetch current organization details","href":"/api-reference/organizations/get-current-organization"},{"openapi":"patch /v1/organizations","title":"Rename organization name","href":"/api-reference/organizations/rename-organization"},{"openapi":"put /v1/organizations/members/{memberId}/roles","title":null,"href":"/api-reference/organizations/update-member-role-to-admin"},{"openapi":"put /v1/organizations/branding","title":"Update organization branding details","href":"/api-reference/organizations/update-organization-branding"},{"openapi":"delete /v1/organizations/members/{memberId}","title":"Remove a member from organization using memberId","href":"/api-reference/organizations/delete-member-from-organization"}]},{"group":"Messages","pages":[{"openapi":"get /v1/messages","title":"List all messages","href":"/api-reference/messages/get-messages"},{"openapi":"delete /v1/messages/{messageId}","title":"Delete a message","href":"/api-reference/messages/delete-message"},{"openapi":"delete /v1/messages/transaction/{transactionId}","title":"Delete messages by transactionId","href":"/api-reference/messages/delete-message-by-transactionid"}]},{"group":"Blueprints","pages":[{"openapi":"get /v1/blueprints/group-by-category","title":null,"href":"/api-reference/get-v1blueprintsgroup-by-category"},{"openapi":"get /v1/blueprints/{templateId}","title":null,"href":"/api-reference/get-v1blueprints"}]}]}]},{"anchor":"Discord Support","icon":"discord","href":"https://discord.gg/novu?ref=docs-instant-help"}]},{"version":"v0.20.0","anchors":[{"anchor":"Documentation","icon":"book-open","pages":[{"title":"Documentation","href":"/getting-started/introduction"}]},{"anchor":"API Reference","icon":"square-terminal","tabs":[{"tab":"API Reference","groups":[{"group":"API Reference","pages":[{"title":"API Overview","description":"In this page you can learn about how to work with Novu's API","href":"/api-reference/overview"},{"title":"API Rate Limiting","href":"/api-reference/rate-limiting"}]},{"group":"Events","pages":[{"openapi":"post /v1/events/trigger","title":"Trigger event","description":"\n Trigger event is the main (and only) way to send notifications to subscribers. The trigger identifier is used to match the particular workflow associated with it. Maximum number of recipients can be 100. Additional information can be passed according the body interface below.\n To prevent duplicate triggers, you can optionally pass a **transactionId** in the request body. If the same **transactionId** is used again, the trigger will be ignored. The retention period depends on your billing tier.","href":"/api-reference/events/trigger-event"},{"openapi":"post /v1/events/trigger/bulk","title":"Bulk trigger event","href":"/api-reference/events/bulk-trigger-event"},{"openapi":"post /v1/events/trigger/broadcast","title":"Broadcast event to all","href":"/api-reference/events/broadcast-event-to-all"},{"openapi":"delete /v1/events/trigger/{transactionId}","title":"Cancel triggered event","href":"/api-reference/events/cancel-triggered-event"}]},{"group":"Subscribers","pages":[{"openapi":"get /v1/subscribers","title":"Get subscribers","href":"/api-reference/subscribers/get-subscribers"},{"openapi":"post /v1/subscribers","title":"Create subscriber","href":"/api-reference/subscribers/create-subscriber"},{"openapi":"post /v1/subscribers/bulk","title":"Bulk create subscribers","href":"/api-reference/subscribers/bulk-create-subscribers"},{"openapi":"get /v1/subscribers/{subscriberId}","title":"Get subscriber","href":"/api-reference/subscribers/get-subscriber"},{"openapi":"put /v1/subscribers/{subscriberId}","title":"Update subscriber","href":"/api-reference/subscribers/update-subscriber"},{"openapi":"delete /v1/subscribers/{subscriberId}","title":"Delete subscriber","href":"/api-reference/subscribers/delete-subscriber"},{"openapi":"put /v1/subscribers/{subscriberId}/credentials","title":"Update provider credentials","href":"/api-reference/subscribers/update-subscriber-credentials"},{"openapi":"delete /v1/subscribers/{subscriberId}/credentials/{providerId}","title":"Delete provider credentials","href":"/api-reference/subscribers/delete-subscriber-credentials-by-providerid"},{"openapi":"patch /v1/subscribers/{subscriberId}/online-status","title":"Update subscriber online status","href":"/api-reference/subscribers/update-subscriber-online-status"},{"openapi":"get /v1/subscribers/{subscriberId}/preferences","title":"Get subscriber preferences","href":"/api-reference/subscribers/get-subscriber-preferences"},{"openapi":"get /v1/subscribers/{subscriberId}/preferences/{level}","title":null,"href":"/api-reference/subscribers/get-subscriber-global-preferences"},{"openapi":"patch /v1/subscribers/{subscriberId}/preferences/{templateId}","title":null,"href":"/api-reference/subscribers/update-subscriber-preference"},{"openapi":"patch /v1/subscribers/{subscriberId}/preferences","title":"Update subscriber global preferences","href":"/api-reference/subscribers/update-subscriber-global-preference"},{"openapi":"get /v1/subscribers/{subscriberId}/notifications/feed","title":"Retrieve subscriber notifications","href":"/api-reference/subscribers/get-in-app-notification-feed-for-a-particular-subscriber"},{"openapi":"get /v1/subscribers/{subscriberId}/notifications/unseen","title":"Retrieve unseen notifications count","href":"/api-reference/subscribers/get-the-unseen-in-app-notifications-count-for-subscribers-feed"},{"openapi":"post /v1/subscribers/{subscriberId}/messages/markAs","title":null,"href":"/api-reference/subscribers/mark-a-subscriber-feed-message-as-seen"},{"openapi":"post /v1/subscribers/{subscriberId}/messages/mark-all","title":"Update all notifications state","href":"/api-reference/subscribers/marks-all-the-subscriber-messages-as-read-unread-seen-or-unseen-optionally-you-can-pass-feed-id-or-array-to-mark-messages-of-a-particular-feed"},{"openapi":"post /v1/subscribers/{subscriberId}/messages/{messageId}/actions/{type}","title":"Update notification action status","href":"/api-reference/subscribers/mark-message-action-as-seen"},{"openapi":"get /v1/subscribers/{subscriberId}/credentials/{providerId}/oauth/callback","title":"Handle providers oauth redirect","href":"/api-reference/subscribers/handle-providers-oauth-redirect"},{"openapi":"get /v1/subscribers/{subscriberId}/credentials/{providerId}/oauth","title":"Handle chat oauth","href":"/api-reference/subscribers/handle-chat-oauth"}]},{"group":"Topics","pages":[{"openapi":"get /v1/topics","title":"Filter topics","href":"/api-reference/topics/filter-topics"},{"openapi":"post /v1/topics","title":"Topic creation","href":"/api-reference/topics/topic-creation"},{"openapi":"post /v1/topics/{topicKey}/subscribers","title":"Subscribers addition","href":"/api-reference/topics/subscribers-addition"},{"openapi":"get /v1/topics/{topicKey}/subscribers/{externalSubscriberId}","title":"Check topic subscriber","href":"/api-reference/topics/check-topic-subscriber"},{"openapi":"post /v1/topics/{topicKey}/subscribers/removal","title":"Subscribers removal","href":"/api-reference/topics/subscribers-removal"},{"openapi":"get /v1/topics/{topicKey}","title":"Get topic","href":"/api-reference/topics/get-topic"},{"openapi":"delete /v1/topics/{topicKey}","title":"Delete topic","href":"/api-reference/topics/delete-topic"},{"openapi":"patch /v1/topics/{topicKey}","title":"Rename a topic","href":"/api-reference/topics/rename-a-topic"}]},{"group":"Notification","pages":[{"openapi":"get /v1/notifications","title":"List all events","href":"/api-reference/notification/get-notifications"},{"openapi":"get /v1/notifications/stats","title":"Get notification statistics","href":"/api-reference/notification/get-notification-statistics"},{"openapi":"get /v1/notifications/graph/stats","title":"Get notification graph statistics","href":"/api-reference/notification/get-notification-graph-statistics"},{"openapi":"get /v1/notifications/{notificationId}","title":"Retrieve an event","href":"/api-reference/notification/get-notification"}]},{"group":"Workflows","pages":[{"openapi":"get /v1/workflows","title":"Get workflows","href":"/api-reference/workflows/get-workflows"},{"openapi":"post /v1/workflows","title":"Create workflow","href":"/api-reference/workflows/create-workflow"},{"openapi":"get /v1/workflows/{workflowIdOrIdentifier}","title":null,"href":"/api-reference/workflows/get-workflow"},{"openapi":"put /v1/workflows/{workflowId}","title":"Update workflow","href":"/api-reference/workflows/update-workflow"},{"openapi":"delete /v1/workflows/{workflowId}","title":"Delete workflow","href":"/api-reference/workflows/delete-workflow"},{"openapi":"put /v1/workflows/{workflowId}/status","title":"Update workflow status","href":"/api-reference/workflows/update-workflow-status"}]},{"group":"Workflow Overrides","pages":[{"openapi":"post /v1/workflow-overrides","title":null,"href":"/api-reference/workflow-overrides/create-workflow-overrides"},{"openapi":"get /v1/workflow-overrides","title":null,"href":"/api-reference/workflow-overrides/get-workflow-overrides"},{"openapi":"get /v1/workflow-overrides/workflows/{workflowId}/tenants/{tenantId}","title":null,"href":"/api-reference/workflow-overrides/get-workflow-override"},{"openapi":"get /v1/workflow-overrides/{overrideId}","title":null,"href":"/api-reference/workflow-overrides/get-workflow-override-by-id"},{"openapi":"put /v1/workflow-overrides/{overrideId}","title":null,"href":"/api-reference/workflow-overrides/update-workflow-override-by-id"},{"openapi":"put /v1/workflow-overrides/workflows/{workflowId}/tenants/{tenantId}","title":null,"href":"/api-reference/workflow-overrides/update-workflow-override"},{"openapi":"delete /v1/workflow-overrides/{overrideId}","title":null,"href":"/api-reference/workflow-overrides/delete-workflow-override"}]},{"group":"Workflow groups","pages":[{"openapi":"get /v1/notification-groups","title":"Get workflow groups","href":"/api-reference/workflow-groups/get-workflow-groups"},{"openapi":"post /v1/notification-groups","title":"Create workflow group","href":"/api-reference/workflow-groups/create-workflow-group"},{"openapi":"get /v1/notification-groups/{id}","title":"Get workflow group","href":"/api-reference/workflow-groups/get-workflow-group"},{"openapi":"delete /v1/notification-groups/{id}","title":"Delete workflow group","href":"/api-reference/workflow-groups/delete-workflow-group"},{"openapi":"patch /v1/notification-groups/{id}","title":"Update workflow group","href":"/api-reference/workflow-groups/update-workflow-group"}]},{"group":"Integrations","pages":[{"openapi":"get /v1/integrations","title":"List all integrations","href":"/api-reference/integrations/get-integrations"},{"openapi":"post /v1/integrations","title":"Create an integration","href":"/api-reference/integrations/create-integration"},{"openapi":"get /v1/integrations/active","title":"List active integrations","href":"/api-reference/integrations/get-active-integrations"},{"openapi":"get /v1/integrations/webhook/provider/{providerId}/status","title":null,"href":"/api-reference/integrations/get-webhook-support-status-for-provider"},{"openapi":"put /v1/integrations/{integrationId}","title":"Update an integration","href":"/api-reference/integrations/update-integration"},{"openapi":"delete /v1/integrations/{integrationId}","title":"Delete an integration","href":"/api-reference/integrations/delete-integration"},{"openapi":"post /v1/integrations/{integrationId}/set-primary","title":"Update integration as primary","href":"/api-reference/integrations/set-integration-as-primary"}]},{"group":"Layouts","pages":[{"openapi":"get /v1/layouts","title":"Filter layouts","href":"/api-reference/layouts/filter-layouts"},{"openapi":"post /v1/layouts","title":"Layout creation","href":"/api-reference/layouts/layout-creation"},{"openapi":"get /v1/layouts/{layoutId}","title":"Get layout","href":"/api-reference/layouts/get-layout"},{"openapi":"delete /v1/layouts/{layoutId}","title":"Delete layout","href":"/api-reference/layouts/delete-layout"},{"openapi":"patch /v1/layouts/{layoutId}","title":"Update a layout","href":"/api-reference/layouts/update-a-layout"},{"openapi":"post /v1/layouts/{layoutId}/default","title":"Set default layout","href":"/api-reference/layouts/set-default-layout"}]},{"group":"Inbound Parse","pages":[{"openapi":"get /v1/inbound-parse/mx/status","title":null,"href":"/api-reference/inbound-parse/validate-the-mx-record-setup-for-the-inbound-parse-functionality"}]},{"group":"Environments","pages":[{"openapi":"get /v1/environments/me","title":"Get current environment","href":"/api-reference/environments/get-current-environment"},{"openapi":"get /v1/environments","title":"List all environments","href":"/api-reference/environments/get-environments"},{"openapi":"get /v1/environments/api-keys","title":"Get api keys","href":"/api-reference/environments/get-api-keys"},{"openapi":"post /v1/environments/api-keys/regenerate","title":"Regenerate api keys","href":"/api-reference/environments/regenerate-api-keys"}]},{"group":"Changes","pages":[{"openapi":"get /v1/changes","title":"Get changes","href":"/api-reference/changes/get-changes"},{"openapi":"get /v1/changes/count","title":"Get changes count","href":"/api-reference/changes/get-changes-count"},{"openapi":"post /v1/changes/bulk/apply","title":"Apply changes","href":"/api-reference/changes/apply-changes"},{"openapi":"post /v1/changes/{changeId}/apply","title":"Apply change","href":"/api-reference/changes/apply-change"}]},{"group":"Execution Details","pages":[{"openapi":"get /v1/execution-details","title":"Get execution details","href":"/api-reference/execution-details/get-execution-details"}]},{"group":"Feeds","pages":[{"openapi":"get /v1/feeds","title":"Get feeds","href":"/api-reference/feeds/get-feeds"},{"openapi":"post /v1/feeds","title":"Create feed","href":"/api-reference/feeds/create-feed"},{"openapi":"delete /v1/feeds/{feedId}","title":"Delete feed","href":"/api-reference/feeds/delete-feed"}]},{"group":"Tenants","pages":[{"openapi":"get /v1/tenants","title":"Get tenants","href":"/api-reference/tenants/get-tenants"},{"openapi":"post /v1/tenants","title":"Create tenant","href":"/api-reference/tenants/create-tenant"},{"openapi":"get /v1/tenants/{identifier}","title":"Get tenant","href":"/api-reference/tenants/get-tenant"},{"openapi":"patch /v1/tenants/{identifier}","title":"Update tenant","href":"/api-reference/tenants/update-tenant"},{"openapi":"delete /v1/tenants/{identifier}","title":"Delete tenant","href":"/api-reference/tenants/delete-tenant"}]},{"group":"Organizations","pages":[{"openapi":"post /v1/organizations","title":"Create an organization","href":"/api-reference/organizations/create-organization"},{"openapi":"get /v1/organizations","title":"Fetch all organizations","href":"/api-reference/organizations/get-all-organizations"},{"openapi":"get /v1/organizations/members","title":"Fetch all members of current organizations","href":"/api-reference/organizations/get-all-members-of-current-organization"},{"openapi":"get /v1/organizations/me","title":"Fetch current organization details","href":"/api-reference/organizations/get-current-organization"},{"openapi":"patch /v1/organizations","title":"Rename organization name","href":"/api-reference/organizations/rename-organization"},{"openapi":"put /v1/organizations/members/{memberId}/roles","title":null,"href":"/api-reference/organizations/update-member-role-to-admin"},{"openapi":"put /v1/organizations/branding","title":"Update organization branding details","href":"/api-reference/organizations/update-organization-branding"},{"openapi":"delete /v1/organizations/members/{memberId}","title":"Remove a member from organization using memberId","href":"/api-reference/organizations/delete-member-from-organization"}]},{"group":"Messages","pages":[{"openapi":"get /v1/messages","title":"List all messages","href":"/api-reference/messages/get-messages"},{"openapi":"delete /v1/messages/{messageId}","title":"Delete a message","href":"/api-reference/messages/delete-message"},{"openapi":"delete /v1/messages/transaction/{transactionId}","title":"Delete messages by transactionId","href":"/api-reference/messages/delete-message-by-transactionid"}]},{"group":"Blueprints","pages":[{"openapi":"get /v1/blueprints/group-by-category","title":null,"href":"/api-reference/get-v1blueprintsgroup-by-category"},{"openapi":"get /v1/blueprints/{templateId}","title":null,"href":"/api-reference/get-v1blueprints"}]}]}]},{"anchor":"Discord Support","icon":"discord","href":"https://discord.gg/novu?ref=docs-instant-help"}]},{"version":"v0.19.0","anchors":[{"anchor":"Documentation","icon":"book-open","pages":[{"title":"Documentation","href":"/getting-started/introduction"}]},{"anchor":"API Reference","icon":"square-terminal","tabs":[{"tab":"API Reference","groups":[{"group":"API Reference","pages":[{"title":"API Overview","description":"In this page you can learn about how to work with Novu's API","href":"/api-reference/overview"},{"title":"API Rate Limiting","href":"/api-reference/rate-limiting"}]},{"group":"Events","pages":[{"openapi":"post /v1/events/trigger","title":"Trigger event","description":"\n Trigger event is the main (and only) way to send notifications to subscribers. The trigger identifier is used to match the particular workflow associated with it. Maximum number of recipients can be 100. Additional information can be passed according the body interface below.\n To prevent duplicate triggers, you can optionally pass a **transactionId** in the request body. If the same **transactionId** is used again, the trigger will be ignored. The retention period depends on your billing tier.","href":"/api-reference/events/trigger-event"},{"openapi":"post /v1/events/trigger/bulk","title":"Bulk trigger event","href":"/api-reference/events/bulk-trigger-event"},{"openapi":"post /v1/events/trigger/broadcast","title":"Broadcast event to all","href":"/api-reference/events/broadcast-event-to-all"},{"openapi":"delete /v1/events/trigger/{transactionId}","title":"Cancel triggered event","href":"/api-reference/events/cancel-triggered-event"}]},{"group":"Subscribers","pages":[{"openapi":"get /v1/subscribers","title":"Get subscribers","href":"/api-reference/subscribers/get-subscribers"},{"openapi":"post /v1/subscribers","title":"Create subscriber","href":"/api-reference/subscribers/create-subscriber"},{"openapi":"post /v1/subscribers/bulk","title":"Bulk create subscribers","href":"/api-reference/subscribers/bulk-create-subscribers"},{"openapi":"get /v1/subscribers/{subscriberId}","title":"Get subscriber","href":"/api-reference/subscribers/get-subscriber"},{"openapi":"put /v1/subscribers/{subscriberId}","title":"Update subscriber","href":"/api-reference/subscribers/update-subscriber"},{"openapi":"delete /v1/subscribers/{subscriberId}","title":"Delete subscriber","href":"/api-reference/subscribers/delete-subscriber"},{"openapi":"put /v1/subscribers/{subscriberId}/credentials","title":"Update provider credentials","href":"/api-reference/subscribers/update-subscriber-credentials"},{"openapi":"delete /v1/subscribers/{subscriberId}/credentials/{providerId}","title":"Delete provider credentials","href":"/api-reference/subscribers/delete-subscriber-credentials-by-providerid"},{"openapi":"patch /v1/subscribers/{subscriberId}/online-status","title":"Update subscriber online status","href":"/api-reference/subscribers/update-subscriber-online-status"},{"openapi":"get /v1/subscribers/{subscriberId}/preferences","title":"Get subscriber preferences","href":"/api-reference/subscribers/get-subscriber-preferences"},{"openapi":"get /v1/subscribers/{subscriberId}/preferences/{level}","title":null,"href":"/api-reference/subscribers/get-subscriber-global-preferences"},{"openapi":"patch /v1/subscribers/{subscriberId}/preferences/{templateId}","title":null,"href":"/api-reference/subscribers/update-subscriber-preference"},{"openapi":"patch /v1/subscribers/{subscriberId}/preferences","title":"Update subscriber global preferences","href":"/api-reference/subscribers/update-subscriber-global-preference"},{"openapi":"get /v1/subscribers/{subscriberId}/notifications/feed","title":"Retrieve subscriber notifications","href":"/api-reference/subscribers/get-in-app-notification-feed-for-a-particular-subscriber"},{"openapi":"get /v1/subscribers/{subscriberId}/notifications/unseen","title":"Retrieve unseen notifications count","href":"/api-reference/subscribers/get-the-unseen-in-app-notifications-count-for-subscribers-feed"},{"openapi":"post /v1/subscribers/{subscriberId}/messages/markAs","title":null,"href":"/api-reference/subscribers/mark-a-subscriber-feed-message-as-seen"},{"openapi":"post /v1/subscribers/{subscriberId}/messages/mark-all","title":"Update all notifications state","href":"/api-reference/subscribers/marks-all-the-subscriber-messages-as-read-unread-seen-or-unseen-optionally-you-can-pass-feed-id-or-array-to-mark-messages-of-a-particular-feed"},{"openapi":"post /v1/subscribers/{subscriberId}/messages/{messageId}/actions/{type}","title":"Update notification action status","href":"/api-reference/subscribers/mark-message-action-as-seen"},{"openapi":"get /v1/subscribers/{subscriberId}/credentials/{providerId}/oauth/callback","title":"Handle providers oauth redirect","href":"/api-reference/subscribers/handle-providers-oauth-redirect"},{"openapi":"get /v1/subscribers/{subscriberId}/credentials/{providerId}/oauth","title":"Handle chat oauth","href":"/api-reference/subscribers/handle-chat-oauth"}]},{"group":"Topics","pages":[{"openapi":"get /v1/topics","title":"Filter topics","href":"/api-reference/topics/filter-topics"},{"openapi":"post /v1/topics","title":"Topic creation","href":"/api-reference/topics/topic-creation"},{"openapi":"post /v1/topics/{topicKey}/subscribers","title":"Subscribers addition","href":"/api-reference/topics/subscribers-addition"},{"openapi":"get /v1/topics/{topicKey}/subscribers/{externalSubscriberId}","title":"Check topic subscriber","href":"/api-reference/topics/check-topic-subscriber"},{"openapi":"post /v1/topics/{topicKey}/subscribers/removal","title":"Subscribers removal","href":"/api-reference/topics/subscribers-removal"},{"openapi":"get /v1/topics/{topicKey}","title":"Get topic","href":"/api-reference/topics/get-topic"},{"openapi":"delete /v1/topics/{topicKey}","title":"Delete topic","href":"/api-reference/topics/delete-topic"},{"openapi":"patch /v1/topics/{topicKey}","title":"Rename a topic","href":"/api-reference/topics/rename-a-topic"}]},{"group":"Notification","pages":[{"openapi":"get /v1/notifications","title":"List all events","href":"/api-reference/notification/get-notifications"},{"openapi":"get /v1/notifications/stats","title":"Get notification statistics","href":"/api-reference/notification/get-notification-statistics"},{"openapi":"get /v1/notifications/graph/stats","title":"Get notification graph statistics","href":"/api-reference/notification/get-notification-graph-statistics"},{"openapi":"get /v1/notifications/{notificationId}","title":"Retrieve an event","href":"/api-reference/notification/get-notification"}]},{"group":"Workflows","pages":[{"openapi":"get /v1/workflows","title":"Get workflows","href":"/api-reference/workflows/get-workflows"},{"openapi":"post /v1/workflows","title":"Create workflow","href":"/api-reference/workflows/create-workflow"},{"openapi":"get /v1/workflows/{workflowIdOrIdentifier}","title":null,"href":"/api-reference/workflows/get-workflow"},{"openapi":"put /v1/workflows/{workflowId}","title":"Update workflow","href":"/api-reference/workflows/update-workflow"},{"openapi":"delete /v1/workflows/{workflowId}","title":"Delete workflow","href":"/api-reference/workflows/delete-workflow"},{"openapi":"put /v1/workflows/{workflowId}/status","title":"Update workflow status","href":"/api-reference/workflows/update-workflow-status"}]},{"group":"Workflow Overrides","pages":[{"openapi":"post /v1/workflow-overrides","title":null,"href":"/api-reference/workflow-overrides/create-workflow-overrides"},{"openapi":"get /v1/workflow-overrides","title":null,"href":"/api-reference/workflow-overrides/get-workflow-overrides"},{"openapi":"get /v1/workflow-overrides/workflows/{workflowId}/tenants/{tenantId}","title":null,"href":"/api-reference/workflow-overrides/get-workflow-override"},{"openapi":"get /v1/workflow-overrides/{overrideId}","title":null,"href":"/api-reference/workflow-overrides/get-workflow-override-by-id"},{"openapi":"put /v1/workflow-overrides/{overrideId}","title":null,"href":"/api-reference/workflow-overrides/update-workflow-override-by-id"},{"openapi":"put /v1/workflow-overrides/workflows/{workflowId}/tenants/{tenantId}","title":null,"href":"/api-reference/workflow-overrides/update-workflow-override"},{"openapi":"delete /v1/workflow-overrides/{overrideId}","title":null,"href":"/api-reference/workflow-overrides/delete-workflow-override"}]},{"group":"Workflow groups","pages":[{"openapi":"get /v1/notification-groups","title":"Get workflow groups","href":"/api-reference/workflow-groups/get-workflow-groups"},{"openapi":"post /v1/notification-groups","title":"Create workflow group","href":"/api-reference/workflow-groups/create-workflow-group"},{"openapi":"get /v1/notification-groups/{id}","title":"Get workflow group","href":"/api-reference/workflow-groups/get-workflow-group"},{"openapi":"delete /v1/notification-groups/{id}","title":"Delete workflow group","href":"/api-reference/workflow-groups/delete-workflow-group"},{"openapi":"patch /v1/notification-groups/{id}","title":"Update workflow group","href":"/api-reference/workflow-groups/update-workflow-group"}]},{"group":"Integrations","pages":[{"openapi":"get /v1/integrations","title":"List all integrations","href":"/api-reference/integrations/get-integrations"},{"openapi":"post /v1/integrations","title":"Create an integration","href":"/api-reference/integrations/create-integration"},{"openapi":"get /v1/integrations/active","title":"List active integrations","href":"/api-reference/integrations/get-active-integrations"},{"openapi":"get /v1/integrations/webhook/provider/{providerId}/status","title":null,"href":"/api-reference/integrations/get-webhook-support-status-for-provider"},{"openapi":"put /v1/integrations/{integrationId}","title":"Update an integration","href":"/api-reference/integrations/update-integration"},{"openapi":"delete /v1/integrations/{integrationId}","title":"Delete an integration","href":"/api-reference/integrations/delete-integration"},{"openapi":"post /v1/integrations/{integrationId}/set-primary","title":"Update integration as primary","href":"/api-reference/integrations/set-integration-as-primary"}]},{"group":"Layouts","pages":[{"openapi":"get /v1/layouts","title":"Filter layouts","href":"/api-reference/layouts/filter-layouts"},{"openapi":"post /v1/layouts","title":"Layout creation","href":"/api-reference/layouts/layout-creation"},{"openapi":"get /v1/layouts/{layoutId}","title":"Get layout","href":"/api-reference/layouts/get-layout"},{"openapi":"delete /v1/layouts/{layoutId}","title":"Delete layout","href":"/api-reference/layouts/delete-layout"},{"openapi":"patch /v1/layouts/{layoutId}","title":"Update a layout","href":"/api-reference/layouts/update-a-layout"},{"openapi":"post /v1/layouts/{layoutId}/default","title":"Set default layout","href":"/api-reference/layouts/set-default-layout"}]},{"group":"Inbound Parse","pages":[{"openapi":"get /v1/inbound-parse/mx/status","title":null,"href":"/api-reference/inbound-parse/validate-the-mx-record-setup-for-the-inbound-parse-functionality"}]},{"group":"Environments","pages":[{"openapi":"get /v1/environments/me","title":"Get current environment","href":"/api-reference/environments/get-current-environment"},{"openapi":"get /v1/environments","title":"List all environments","href":"/api-reference/environments/get-environments"},{"openapi":"get /v1/environments/api-keys","title":"Get api keys","href":"/api-reference/environments/get-api-keys"},{"openapi":"post /v1/environments/api-keys/regenerate","title":"Regenerate api keys","href":"/api-reference/environments/regenerate-api-keys"}]},{"group":"Changes","pages":[{"openapi":"get /v1/changes","title":"Get changes","href":"/api-reference/changes/get-changes"},{"openapi":"get /v1/changes/count","title":"Get changes count","href":"/api-reference/changes/get-changes-count"},{"openapi":"post /v1/changes/bulk/apply","title":"Apply changes","href":"/api-reference/changes/apply-changes"},{"openapi":"post /v1/changes/{changeId}/apply","title":"Apply change","href":"/api-reference/changes/apply-change"}]},{"group":"Execution Details","pages":[{"openapi":"get /v1/execution-details","title":"Get execution details","href":"/api-reference/execution-details/get-execution-details"}]},{"group":"Feeds","pages":[{"openapi":"get /v1/feeds","title":"Get feeds","href":"/api-reference/feeds/get-feeds"},{"openapi":"post /v1/feeds","title":"Create feed","href":"/api-reference/feeds/create-feed"},{"openapi":"delete /v1/feeds/{feedId}","title":"Delete feed","href":"/api-reference/feeds/delete-feed"}]},{"group":"Tenants","pages":[{"openapi":"get /v1/tenants","title":"Get tenants","href":"/api-reference/tenants/get-tenants"},{"openapi":"post /v1/tenants","title":"Create tenant","href":"/api-reference/tenants/create-tenant"},{"openapi":"get /v1/tenants/{identifier}","title":"Get tenant","href":"/api-reference/tenants/get-tenant"},{"openapi":"patch /v1/tenants/{identifier}","title":"Update tenant","href":"/api-reference/tenants/update-tenant"},{"openapi":"delete /v1/tenants/{identifier}","title":"Delete tenant","href":"/api-reference/tenants/delete-tenant"}]},{"group":"Organizations","pages":[{"openapi":"post /v1/organizations","title":"Create an organization","href":"/api-reference/organizations/create-organization"},{"openapi":"get /v1/organizations","title":"Fetch all organizations","href":"/api-reference/organizations/get-all-organizations"},{"openapi":"get /v1/organizations/members","title":"Fetch all members of current organizations","href":"/api-reference/organizations/get-all-members-of-current-organization"},{"openapi":"get /v1/organizations/me","title":"Fetch current organization details","href":"/api-reference/organizations/get-current-organization"},{"openapi":"patch /v1/organizations","title":"Rename organization name","href":"/api-reference/organizations/rename-organization"},{"openapi":"put /v1/organizations/members/{memberId}/roles","title":null,"href":"/api-reference/organizations/update-member-role-to-admin"},{"openapi":"put /v1/organizations/branding","title":"Update organization branding details","href":"/api-reference/organizations/update-organization-branding"},{"openapi":"delete /v1/organizations/members/{memberId}","title":"Remove a member from organization using memberId","href":"/api-reference/organizations/delete-member-from-organization"}]},{"group":"Messages","pages":[{"openapi":"get /v1/messages","title":"List all messages","href":"/api-reference/messages/get-messages"},{"openapi":"delete /v1/messages/{messageId}","title":"Delete a message","href":"/api-reference/messages/delete-message"},{"openapi":"delete /v1/messages/transaction/{transactionId}","title":"Delete messages by transactionId","href":"/api-reference/messages/delete-message-by-transactionid"}]},{"group":"Blueprints","pages":[{"openapi":"get /v1/blueprints/group-by-category","title":null,"href":"/api-reference/get-v1blueprintsgroup-by-category"},{"openapi":"get /v1/blueprints/{templateId}","title":null,"href":"/api-reference/get-v1blueprints"}]}]}]},{"anchor":"Discord Support","icon":"discord","href":"https://discord.gg/novu?ref=docs-instant-help"}]},{"version":"v0.18.0","anchors":[{"anchor":"Documentation","icon":"book-open","pages":[{"title":"Documentation","href":"/getting-started/introduction"}]},{"anchor":"API Reference","icon":"square-terminal","tabs":[{"tab":"API Reference","groups":[{"group":"API Reference","pages":[{"title":"API Overview","description":"In this page you can learn about how to work with Novu's API","href":"/api-reference/overview"},{"title":"API Rate Limiting","href":"/api-reference/rate-limiting"}]},{"group":"Events","pages":[{"openapi":"post /v1/events/trigger","title":"Trigger event","description":"\n Trigger event is the main (and only) way to send notifications to subscribers. The trigger identifier is used to match the particular workflow associated with it. Maximum number of recipients can be 100. Additional information can be passed according the body interface below.\n To prevent duplicate triggers, you can optionally pass a **transactionId** in the request body. If the same **transactionId** is used again, the trigger will be ignored. The retention period depends on your billing tier.","href":"/api-reference/events/trigger-event"},{"openapi":"post /v1/events/trigger/bulk","title":"Bulk trigger event","href":"/api-reference/events/bulk-trigger-event"},{"openapi":"post /v1/events/trigger/broadcast","title":"Broadcast event to all","href":"/api-reference/events/broadcast-event-to-all"},{"openapi":"delete /v1/events/trigger/{transactionId}","title":"Cancel triggered event","href":"/api-reference/events/cancel-triggered-event"}]},{"group":"Subscribers","pages":[{"openapi":"get /v1/subscribers","title":"Get subscribers","href":"/api-reference/subscribers/get-subscribers"},{"openapi":"post /v1/subscribers","title":"Create subscriber","href":"/api-reference/subscribers/create-subscriber"},{"openapi":"post /v1/subscribers/bulk","title":"Bulk create subscribers","href":"/api-reference/subscribers/bulk-create-subscribers"},{"openapi":"get /v1/subscribers/{subscriberId}","title":"Get subscriber","href":"/api-reference/subscribers/get-subscriber"},{"openapi":"put /v1/subscribers/{subscriberId}","title":"Update subscriber","href":"/api-reference/subscribers/update-subscriber"},{"openapi":"delete /v1/subscribers/{subscriberId}","title":"Delete subscriber","href":"/api-reference/subscribers/delete-subscriber"},{"openapi":"put /v1/subscribers/{subscriberId}/credentials","title":"Update provider credentials","href":"/api-reference/subscribers/update-subscriber-credentials"},{"openapi":"delete /v1/subscribers/{subscriberId}/credentials/{providerId}","title":"Delete provider credentials","href":"/api-reference/subscribers/delete-subscriber-credentials-by-providerid"},{"openapi":"patch /v1/subscribers/{subscriberId}/online-status","title":"Update subscriber online status","href":"/api-reference/subscribers/update-subscriber-online-status"},{"openapi":"get /v1/subscribers/{subscriberId}/preferences","title":"Get subscriber preferences","href":"/api-reference/subscribers/get-subscriber-preferences"},{"openapi":"get /v1/subscribers/{subscriberId}/preferences/{level}","title":null,"href":"/api-reference/subscribers/get-subscriber-global-preferences"},{"openapi":"patch /v1/subscribers/{subscriberId}/preferences/{templateId}","title":null,"href":"/api-reference/subscribers/update-subscriber-preference"},{"openapi":"patch /v1/subscribers/{subscriberId}/preferences","title":"Update subscriber global preferences","href":"/api-reference/subscribers/update-subscriber-global-preference"},{"openapi":"get /v1/subscribers/{subscriberId}/notifications/feed","title":"Retrieve subscriber notifications","href":"/api-reference/subscribers/get-in-app-notification-feed-for-a-particular-subscriber"},{"openapi":"get /v1/subscribers/{subscriberId}/notifications/unseen","title":"Retrieve unseen notifications count","href":"/api-reference/subscribers/get-the-unseen-in-app-notifications-count-for-subscribers-feed"},{"openapi":"post /v1/subscribers/{subscriberId}/messages/markAs","title":null,"href":"/api-reference/subscribers/mark-a-subscriber-feed-message-as-seen"},{"openapi":"post /v1/subscribers/{subscriberId}/messages/mark-all","title":"Update all notifications state","href":"/api-reference/subscribers/marks-all-the-subscriber-messages-as-read-unread-seen-or-unseen-optionally-you-can-pass-feed-id-or-array-to-mark-messages-of-a-particular-feed"},{"openapi":"post /v1/subscribers/{subscriberId}/messages/{messageId}/actions/{type}","title":"Update notification action status","href":"/api-reference/subscribers/mark-message-action-as-seen"},{"openapi":"get /v1/subscribers/{subscriberId}/credentials/{providerId}/oauth/callback","title":"Handle providers oauth redirect","href":"/api-reference/subscribers/handle-providers-oauth-redirect"},{"openapi":"get /v1/subscribers/{subscriberId}/credentials/{providerId}/oauth","title":"Handle chat oauth","href":"/api-reference/subscribers/handle-chat-oauth"}]},{"group":"Topics","pages":[{"openapi":"get /v1/topics","title":"Filter topics","href":"/api-reference/topics/filter-topics"},{"openapi":"post /v1/topics","title":"Topic creation","href":"/api-reference/topics/topic-creation"},{"openapi":"post /v1/topics/{topicKey}/subscribers","title":"Subscribers addition","href":"/api-reference/topics/subscribers-addition"},{"openapi":"get /v1/topics/{topicKey}/subscribers/{externalSubscriberId}","title":"Check topic subscriber","href":"/api-reference/topics/check-topic-subscriber"},{"openapi":"post /v1/topics/{topicKey}/subscribers/removal","title":"Subscribers removal","href":"/api-reference/topics/subscribers-removal"},{"openapi":"get /v1/topics/{topicKey}","title":"Get topic","href":"/api-reference/topics/get-topic"},{"openapi":"delete /v1/topics/{topicKey}","title":"Delete topic","href":"/api-reference/topics/delete-topic"},{"openapi":"patch /v1/topics/{topicKey}","title":"Rename a topic","href":"/api-reference/topics/rename-a-topic"}]},{"group":"Notification","pages":[{"openapi":"get /v1/notifications","title":"List all events","href":"/api-reference/notification/get-notifications"},{"openapi":"get /v1/notifications/stats","title":"Get notification statistics","href":"/api-reference/notification/get-notification-statistics"},{"openapi":"get /v1/notifications/graph/stats","title":"Get notification graph statistics","href":"/api-reference/notification/get-notification-graph-statistics"},{"openapi":"get /v1/notifications/{notificationId}","title":"Retrieve an event","href":"/api-reference/notification/get-notification"}]},{"group":"Workflows","pages":[{"openapi":"get /v1/workflows","title":"Get workflows","href":"/api-reference/workflows/get-workflows"},{"openapi":"post /v1/workflows","title":"Create workflow","href":"/api-reference/workflows/create-workflow"},{"openapi":"get /v1/workflows/{workflowIdOrIdentifier}","title":null,"href":"/api-reference/workflows/get-workflow"},{"openapi":"put /v1/workflows/{workflowId}","title":"Update workflow","href":"/api-reference/workflows/update-workflow"},{"openapi":"delete /v1/workflows/{workflowId}","title":"Delete workflow","href":"/api-reference/workflows/delete-workflow"},{"openapi":"put /v1/workflows/{workflowId}/status","title":"Update workflow status","href":"/api-reference/workflows/update-workflow-status"}]},{"group":"Workflow Overrides","pages":[{"openapi":"post /v1/workflow-overrides","title":null,"href":"/api-reference/workflow-overrides/create-workflow-overrides"},{"openapi":"get /v1/workflow-overrides","title":null,"href":"/api-reference/workflow-overrides/get-workflow-overrides"},{"openapi":"get /v1/workflow-overrides/workflows/{workflowId}/tenants/{tenantId}","title":null,"href":"/api-reference/workflow-overrides/get-workflow-override"},{"openapi":"get /v1/workflow-overrides/{overrideId}","title":null,"href":"/api-reference/workflow-overrides/get-workflow-override-by-id"},{"openapi":"put /v1/workflow-overrides/{overrideId}","title":null,"href":"/api-reference/workflow-overrides/update-workflow-override-by-id"},{"openapi":"put /v1/workflow-overrides/workflows/{workflowId}/tenants/{tenantId}","title":null,"href":"/api-reference/workflow-overrides/update-workflow-override"},{"openapi":"delete /v1/workflow-overrides/{overrideId}","title":null,"href":"/api-reference/workflow-overrides/delete-workflow-override"}]},{"group":"Workflow groups","pages":[{"openapi":"get /v1/notification-groups","title":"Get workflow groups","href":"/api-reference/workflow-groups/get-workflow-groups"},{"openapi":"post /v1/notification-groups","title":"Create workflow group","href":"/api-reference/workflow-groups/create-workflow-group"},{"openapi":"get /v1/notification-groups/{id}","title":"Get workflow group","href":"/api-reference/workflow-groups/get-workflow-group"},{"openapi":"delete /v1/notification-groups/{id}","title":"Delete workflow group","href":"/api-reference/workflow-groups/delete-workflow-group"},{"openapi":"patch /v1/notification-groups/{id}","title":"Update workflow group","href":"/api-reference/workflow-groups/update-workflow-group"}]},{"group":"Integrations","pages":[{"openapi":"get /v1/integrations","title":"List all integrations","href":"/api-reference/integrations/get-integrations"},{"openapi":"post /v1/integrations","title":"Create an integration","href":"/api-reference/integrations/create-integration"},{"openapi":"get /v1/integrations/active","title":"List active integrations","href":"/api-reference/integrations/get-active-integrations"},{"openapi":"get /v1/integrations/webhook/provider/{providerId}/status","title":null,"href":"/api-reference/integrations/get-webhook-support-status-for-provider"},{"openapi":"put /v1/integrations/{integrationId}","title":"Update an integration","href":"/api-reference/integrations/update-integration"},{"openapi":"delete /v1/integrations/{integrationId}","title":"Delete an integration","href":"/api-reference/integrations/delete-integration"},{"openapi":"post /v1/integrations/{integrationId}/set-primary","title":"Update integration as primary","href":"/api-reference/integrations/set-integration-as-primary"}]},{"group":"Layouts","pages":[{"openapi":"get /v1/layouts","title":"Filter layouts","href":"/api-reference/layouts/filter-layouts"},{"openapi":"post /v1/layouts","title":"Layout creation","href":"/api-reference/layouts/layout-creation"},{"openapi":"get /v1/layouts/{layoutId}","title":"Get layout","href":"/api-reference/layouts/get-layout"},{"openapi":"delete /v1/layouts/{layoutId}","title":"Delete layout","href":"/api-reference/layouts/delete-layout"},{"openapi":"patch /v1/layouts/{layoutId}","title":"Update a layout","href":"/api-reference/layouts/update-a-layout"},{"openapi":"post /v1/layouts/{layoutId}/default","title":"Set default layout","href":"/api-reference/layouts/set-default-layout"}]},{"group":"Inbound Parse","pages":[{"openapi":"get /v1/inbound-parse/mx/status","title":null,"href":"/api-reference/inbound-parse/validate-the-mx-record-setup-for-the-inbound-parse-functionality"}]},{"group":"Environments","pages":[{"openapi":"get /v1/environments/me","title":"Get current environment","href":"/api-reference/environments/get-current-environment"},{"openapi":"get /v1/environments","title":"List all environments","href":"/api-reference/environments/get-environments"},{"openapi":"get /v1/environments/api-keys","title":"Get api keys","href":"/api-reference/environments/get-api-keys"},{"openapi":"post /v1/environments/api-keys/regenerate","title":"Regenerate api keys","href":"/api-reference/environments/regenerate-api-keys"}]},{"group":"Changes","pages":[{"openapi":"get /v1/changes","title":"Get changes","href":"/api-reference/changes/get-changes"},{"openapi":"get /v1/changes/count","title":"Get changes count","href":"/api-reference/changes/get-changes-count"},{"openapi":"post /v1/changes/bulk/apply","title":"Apply changes","href":"/api-reference/changes/apply-changes"},{"openapi":"post /v1/changes/{changeId}/apply","title":"Apply change","href":"/api-reference/changes/apply-change"}]},{"group":"Execution Details","pages":[{"openapi":"get /v1/execution-details","title":"Get execution details","href":"/api-reference/execution-details/get-execution-details"}]},{"group":"Feeds","pages":[{"openapi":"get /v1/feeds","title":"Get feeds","href":"/api-reference/feeds/get-feeds"},{"openapi":"post /v1/feeds","title":"Create feed","href":"/api-reference/feeds/create-feed"},{"openapi":"delete /v1/feeds/{feedId}","title":"Delete feed","href":"/api-reference/feeds/delete-feed"}]},{"group":"Tenants","pages":[{"openapi":"get /v1/tenants","title":"Get tenants","href":"/api-reference/tenants/get-tenants"},{"openapi":"post /v1/tenants","title":"Create tenant","href":"/api-reference/tenants/create-tenant"},{"openapi":"get /v1/tenants/{identifier}","title":"Get tenant","href":"/api-reference/tenants/get-tenant"},{"openapi":"patch /v1/tenants/{identifier}","title":"Update tenant","href":"/api-reference/tenants/update-tenant"},{"openapi":"delete /v1/tenants/{identifier}","title":"Delete tenant","href":"/api-reference/tenants/delete-tenant"}]},{"group":"Organizations","pages":[{"openapi":"post /v1/organizations","title":"Create an organization","href":"/api-reference/organizations/create-organization"},{"openapi":"get /v1/organizations","title":"Fetch all organizations","href":"/api-reference/organizations/get-all-organizations"},{"openapi":"get /v1/organizations/members","title":"Fetch all members of current organizations","href":"/api-reference/organizations/get-all-members-of-current-organization"},{"openapi":"get /v1/organizations/me","title":"Fetch current organization details","href":"/api-reference/organizations/get-current-organization"},{"openapi":"patch /v1/organizations","title":"Rename organization name","href":"/api-reference/organizations/rename-organization"},{"openapi":"put /v1/organizations/members/{memberId}/roles","title":null,"href":"/api-reference/organizations/update-member-role-to-admin"},{"openapi":"put /v1/organizations/branding","title":"Update organization branding details","href":"/api-reference/organizations/update-organization-branding"},{"openapi":"delete /v1/organizations/members/{memberId}","title":"Remove a member from organization using memberId","href":"/api-reference/organizations/delete-member-from-organization"}]},{"group":"Messages","pages":[{"openapi":"get /v1/messages","title":"List all messages","href":"/api-reference/messages/get-messages"},{"openapi":"delete /v1/messages/{messageId}","title":"Delete a message","href":"/api-reference/messages/delete-message"},{"openapi":"delete /v1/messages/transaction/{transactionId}","title":"Delete messages by transactionId","href":"/api-reference/messages/delete-message-by-transactionid"}]},{"group":"Blueprints","pages":[{"openapi":"get /v1/blueprints/group-by-category","title":null,"href":"/api-reference/get-v1blueprintsgroup-by-category"},{"openapi":"get /v1/blueprints/{templateId}","title":null,"href":"/api-reference/get-v1blueprints"}]}]}]},{"anchor":"Discord Support","icon":"discord","href":"https://discord.gg/novu?ref=docs-instant-help"}]}]},"basePath":"","title":"API Rate Limiting - Novu","buildId":"dpl_FWZhTb2vab28gFGFH4ojka6qEznQ","deploymentId":"dpl_FWZhTb2vab28gFGFH4ojka6qEznQ","dynamics":[],"chunks":[]}