import { Novu } from "@novu/api";import { UpdateSubscriberChannelRequestDtoProviderId } from "@novu/api/models/components";const novu = new Novu({ apiKey: "<YOUR_API_KEY_HERE>",});async function run() { const result = await novu.subscribers.credentials.update("<value>", { providerId: UpdateSubscriberChannelRequestDtoProviderId.Pushpad, credentials: { webhookUrl: "<value>", }, }); // Handle the result console.log(result)}run();
"Request with key 3909d656-d4fe-4e80-ba86-90d3861afcd7 is currently being processed. Please retry after 1 second"
"API rate limit exceeded"
"Please wait some time, then try again."
Subscribers
Update provider credentials
Update credentials for a provider such as slack and FCM.
providerId is required field. This API creates the deviceTokens or replaces the existing ones.
PUT
/
v1
/
subscribers
/
{subscriberId}
/
credentials
SubscribersController_updateSubscriberChannel
import { Novu } from "@novu/api";import { UpdateSubscriberChannelRequestDtoProviderId } from "@novu/api/models/components";const novu = new Novu({ apiKey: "<YOUR_API_KEY_HERE>",});async function run() { const result = await novu.subscribers.credentials.update("<value>", { providerId: UpdateSubscriberChannelRequestDtoProviderId.Pushpad, credentials: { webhookUrl: "<value>", }, }); // Handle the result console.log(result)}run();
{"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":""},"chroma":{"liveDeploymentHistoryId":"6a3b8954ebea45ce91c3e629","collectionId":"236c75b9-6a6b-49a2-83a0-429b2be65a92","schemaVersion":"v3"},"feedback":{"thumbs":true,"edits":true,"issues":true},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6a3b8954ebea45ce91c3e629:success","clientVersion":"0.0.4006","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":"editor-v7-file-tree","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"per-site-search-delta","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-nav-generations","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/subscribers/update-subscriber-credentials","slug":"/api-reference/subscribers/update-subscriber-credentials","pageMetadata":{"openapi":"put /v1/subscribers/{subscriberId}/credentials","title":"Update provider credentials","description":"Update credentials for a provider such as **slack** and **FCM**. \n **providerId** is required field. This API creates the **deviceTokens** or replaces the existing ones.","href":"/api-reference/subscribers/update-subscriber-credentials"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n strong: \"strong\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"Update credentials for a provider such as \", _jsx(_components.strong, {\n children: \"slack\"\n }), \" and \", _jsx(_components.strong, {\n children: \"FCM\"\n }), \".\\n\", _jsx(_components.strong, {\n children: \"providerId\"\n }), \" is required field. This API creates the \", _jsx(_components.strong, {\n children: \"deviceTokens\"\n }), \" or replaces the existing ones.\"]\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{jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={code:`code`,p:`p`,..._provideComponents(),...props.components},{Warning}=_components;if(!Warning)_missingMdxReference(`Warning`,true);return _jsxs(Warning,{children:[_jsxs(_components.p,{children:[`Enter your API key in the `,_jsx(_components.code,{children:`Authorization`}),` field like the example shown below:`]}),_jsxs(_components.p,{children:[`E.g `,_jsx(_components.code,{children:`ApiKey 18d2e625f05d80e`})]})]})}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":{"openapi":"put /v1/subscribers/{subscriberId}/credentials","title":"Update provider credentials","description":"Update credentials for a provider such as **slack** and **FCM**. \n **providerId** is required field. This API creates the **deviceTokens** or replaces the existing ones.","href":"/api-reference/subscribers/update-subscriber-credentials"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"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"],"openApiReferenceData":{"operation":{"operationId":"SubscribersController_updateSubscriberChannel","x-speakeasy-group":"Subscribers.Credentials","summary":"Update subscriber credentials","description":"Update credentials for a provider such as **slack** and **FCM**. \n **providerId** is required field. This API creates the **deviceTokens** or replaces the existing ones.","parameters":["631e065f-f21d-40d3-9992-40b6193eb1de"],"requestBody":"f331e662-e9f0-43b8-8a74-6c624caf69a4","responses":{"200":"95078340-3a4d-4dfb-b8de-f0e1891e9877","409":"0ffaa1e3-6f65-45bd-9075-42267f491e2d","429":"34d776a4-287b-42b1-bb1a-dcc3e5ead52c","503":"cd805b46-f347-418c-8dbc-51e73f3acd8f"},"tags":["Subscribers"],"security":["4254ac2e-858a-4aed-8a7b-fc61a00ece3c"],"x-codeSamples":[{"lang":"typescript","label":"SubscribersController_updateSubscriberChannel","source":"import { Novu } from \"@novu/api\";\nimport { UpdateSubscriberChannelRequestDtoProviderId } from \"@novu/api/models/components\";\n\nconst novu = new Novu({\n apiKey: \"\u003cYOUR_API_KEY_HERE>\",\n});\n\nasync function run() {\n const result = await novu.subscribers.credentials.update(\"\u003cvalue>\", {\n providerId: UpdateSubscriberChannelRequestDtoProviderId.Pushpad,\n credentials: {\n webhookUrl: \"\u003cvalue>\",\n },\n });\n\n // Handle the result\n console.log(result)\n}\n\nrun();"}],"method":"put","type":"path","servers":["ab5dfd93-1629-49d4-bf05-46d1f1ac4f80","2865ec2b-d37b-4f89-9008-1b99197b6084"],"path":"/v1/subscribers/{subscriberId}/credentials","baseUrlOptions":["https://api.novu.co","https://eu.api.novu.co"],"title":"Update subscriber credentials","codeSamples":[{"label":"SubscribersController_updateSubscriberChannel","lang":"typescript","source":"import { Novu } from \"@novu/api\";\nimport { UpdateSubscriberChannelRequestDtoProviderId } from \"@novu/api/models/components\";\n\nconst novu = new Novu({\n apiKey: \"\u003cYOUR_API_KEY_HERE>\",\n});\n\nasync function run() {\n const result = await novu.subscribers.credentials.update(\"\u003cvalue>\", {\n providerId: UpdateSubscriberChannelRequestDtoProviderId.Pushpad,\n credentials: {\n webhookUrl: \"\u003cvalue>\",\n },\n });\n\n // Handle the result\n console.log(result)\n}\n\nrun();"}],"requiredOnlyExamples":false,"requestExampleType":"codeSamples","responseExampleType":"generated"},"dependencies":{"parameters":{"631e065f-f21d-40d3-9992-40b6193eb1de":{"name":"subscriberId","required":true,"in":"path","schema":{"type":"string","isRequired":true,"uniqueKey":"","typeLabel":"string"}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"providerId":{"type":"string","enum":["slack","discord","msteams","mattermost","ryver","zulip","grafana-on-call","getstream","rocket-chat","whatsapp-business","fcm","apns","expo","one-signal","pushpad","push-webhook","pusher-beams"],"description":"The provider identifier for the credentials","isRequired":true,"uniqueKey":"providerId","typeLabel":"enum\u003cstring>"},"credentials":{"type":"object","description":"Credentials payload for the specified provider","required":["webhookUrl"],"properties":{"webhookUrl":{"type":"string","description":"Webhook url used by chat app integrations. The webhook should be obtained from the chat app provider.","isRequired":true,"uniqueKey":"credentials.webhookUrl","typeLabel":"string"},"channel":{"type":"string","description":"Channel specification for Mattermost chat notifications","uniqueKey":"credentials.channel","typeLabel":"string"},"deviceTokens":{"description":"Contains an array of the subscriber device tokens for a given provider. Used on Push integrations","type":"array","items":{"type":"string","uniqueKey":"credentials.deviceTokens.items.[INDEX]","typeLabel":"string"},"uniqueKey":"credentials.deviceTokens","typeLabel":"string[]"},"alertUid":{"type":"string","description":"alert_uid for grafana on-call webhook payload","uniqueKey":"credentials.alertUid","typeLabel":"string"},"title":{"type":"string","description":"title to be used with grafana on call webhook","uniqueKey":"credentials.title","typeLabel":"string"},"imageUrl":{"type":"string","description":"image_url property fo grafana on call webhook","uniqueKey":"credentials.imageUrl","typeLabel":"string"},"state":{"type":"string","description":"state property fo grafana on call webhook","uniqueKey":"credentials.state","typeLabel":"string"},"externalUrl":{"type":"string","description":"link_to_upstream_details property fo grafana on call webhook","uniqueKey":"credentials.externalUrl","typeLabel":"string"}},"isRequired":true,"uniqueKey":"credentials","typeLabel":"object"},"integrationIdentifier":{"type":"string","description":"The integration identifier","uniqueKey":"integrationIdentifier","typeLabel":"string"}},"required":["providerId","credentials"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"credentials":{"webhookUrl":"\u003cstring>","channel":"\u003cstring>","deviceTokens":["\u003cstring>"],"alertUid":"\u003cstring>","title":"\u003cstring>","imageUrl":"\u003cstring>","state":"\u003cstring>","externalUrl":"\u003cstring>"},"integrationIdentifier":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"95078340-3a4d-4dfb-b8de-f0e1891e9877":{"description":"Ok","content":{"application/json":{"schema":{"type":"object","properties":{"subscriberId":{"type":"string","description":"The internal identifier you used to create this subscriber, usually correlates to the id the user in your systems","isRequired":true,"uniqueKey":"subscriberId","typeLabel":"string"},"_organizationId":{"type":"string","isRequired":true,"uniqueKey":"_organizationId","typeLabel":"string"},"_environmentId":{"type":"string","isRequired":true,"uniqueKey":"_environmentId","typeLabel":"string"},"deleted":{"type":"boolean","isRequired":true,"uniqueKey":"deleted","typeLabel":"boolean"},"createdAt":{"type":"string","isRequired":true,"uniqueKey":"createdAt","typeLabel":"string"},"updatedAt":{"type":"string","isRequired":true,"uniqueKey":"updatedAt","typeLabel":"string"},"_id":{"type":"string","description":"The internal id novu generated for your subscriber, this is not the subscriberId matching your query. See `subscriberId` for that","uniqueKey":"_id","typeLabel":"string"},"firstName":{"type":"string","uniqueKey":"firstName","typeLabel":"string"},"lastName":{"type":"string","uniqueKey":"lastName","typeLabel":"string"},"email":{"type":"string","uniqueKey":"email","typeLabel":"string"},"phone":{"type":"string","uniqueKey":"phone","typeLabel":"string"},"avatar":{"type":"string","uniqueKey":"avatar","typeLabel":"string"},"locale":{"type":"string","uniqueKey":"locale","typeLabel":"string"},"channels":{"description":"Channels settings for subscriber","type":"array","items":{"type":"object","properties":{"providerId":{"type":"string","enum":["slack","discord","msteams","mattermost","ryver","zulip","grafana-on-call","getstream","rocket-chat","whatsapp-business","fcm","apns","expo","one-signal","pushpad","push-webhook","pusher-beams"],"description":"The provider identifier for the credentials","isRequired":true,"uniqueKey":"channels.items.[INDEX].providerId","typeLabel":"enum\u003cstring>"},"credentials":{"type":"object","description":"Credentials payload for the specified provider","required":["webhookUrl"],"properties":{"webhookUrl":{"type":"string","description":"Webhook url used by chat app integrations. The webhook should be obtained from the chat app provider.","isRequired":true,"uniqueKey":"channels.items.[INDEX].credentials.webhookUrl","typeLabel":"string"},"channel":{"type":"string","description":"Channel specification for Mattermost chat notifications","uniqueKey":"channels.items.[INDEX].credentials.channel","typeLabel":"string"},"deviceTokens":{"description":"Contains an array of the subscriber device tokens for a given provider. Used on Push integrations","type":"array","items":{"type":"string","uniqueKey":"channels.items.[INDEX].credentials.deviceTokens.items.[INDEX]","typeLabel":"string"},"uniqueKey":"channels.items.[INDEX].credentials.deviceTokens","typeLabel":"string[]"},"alertUid":{"type":"string","description":"alert_uid for grafana on-call webhook payload","uniqueKey":"channels.items.[INDEX].credentials.alertUid","typeLabel":"string"},"title":{"type":"string","description":"title to be used with grafana on call webhook","uniqueKey":"channels.items.[INDEX].credentials.title","typeLabel":"string"},"imageUrl":{"type":"string","description":"image_url property fo grafana on call webhook","uniqueKey":"channels.items.[INDEX].credentials.imageUrl","typeLabel":"string"},"state":{"type":"string","description":"state property fo grafana on call webhook","uniqueKey":"channels.items.[INDEX].credentials.state","typeLabel":"string"},"externalUrl":{"type":"string","description":"link_to_upstream_details property fo grafana on call webhook","uniqueKey":"channels.items.[INDEX].credentials.externalUrl","typeLabel":"string"}},"isRequired":true,"uniqueKey":"channels.items.[INDEX].credentials","typeLabel":"object"},"_integrationId":{"type":"string","description":"Id of the integration that is used for this channel","isRequired":true,"uniqueKey":"channels.items.[INDEX]._integrationId","typeLabel":"string"},"integrationIdentifier":{"type":"string","description":"The integration identifier","uniqueKey":"channels.items.[INDEX].integrationIdentifier","typeLabel":"string"}},"required":["providerId","credentials","_integrationId"],"uniqueKey":"channels.items.[INDEX]","typeLabel":"object"},"uniqueKey":"channels","typeLabel":"object[]"},"isOnline":{"type":"boolean","uniqueKey":"isOnline","typeLabel":"boolean"},"lastOnlineAt":{"type":"string","uniqueKey":"lastOnlineAt","typeLabel":"string"},"__v":{"type":"number","uniqueKey":"__v","typeLabel":"number"}},"required":["subscriberId","_organizationId","_environmentId","deleted","createdAt","updatedAt"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"subscriberId":"\u003cstring>","_organizationId":"\u003cstring>","_environmentId":"\u003cstring>","deleted":true,"createdAt":"\u003cstring>","updatedAt":"\u003cstring>","_id":"\u003cstring>","firstName":"\u003cstring>","lastName":"\u003cstring>","email":"\u003cstring>","phone":"\u003cstring>","avatar":"\u003cstring>","locale":"\u003cstring>","channels":[{"providerId":"slack","credentials":{"webhookUrl":"\u003cstring>","channel":"\u003cstring>","deviceTokens":["\u003cstring>"],"alertUid":"\u003cstring>","title":"\u003cstring>","imageUrl":"\u003cstring>","state":"\u003cstring>","externalUrl":"\u003cstring>"},"_integrationId":"\u003cstring>","integrationIdentifier":"\u003cstring>"}],"isOnline":true,"lastOnlineAt":"\u003cstring>","__v":123}}},"exampleType":"generated"}},"exampleType":"generated"},"0ffaa1e3-6f65-45bd-9075-42267f491e2d":{"description":"The request could not be completed due to a conflict with the current state of the target resource.","content":{"application/json":{"schema":{"type":"string","example":"Request with key 3909d656-d4fe-4e80-ba86-90d3861afcd7 is currently being processed. Please retry after 1 second","uniqueKey":"","typeLabel":"string"},"examples":{"Example":{"title":"Example","value":"Request with key 3909d656-d4fe-4e80-ba86-90d3861afcd7 is currently being processed. Please retry after 1 second"}},"exampleType":"generated"}},"exampleType":"generated"},"34d776a4-287b-42b1-bb1a-dcc3e5ead52c":{"description":"The client has sent too many requests in a given amount of time. ","content":{"application/json":{"schema":{"type":"string","example":"API rate limit exceeded","uniqueKey":"","typeLabel":"string"},"examples":{"Example":{"title":"Example","value":"API rate limit exceeded"}},"exampleType":"generated"}},"exampleType":"generated"},"cd805b46-f347-418c-8dbc-51e73f3acd8f":{"description":"The server is currently unable to handle the request due to a temporary overload or scheduled maintenance, which will likely be alleviated after some delay.","content":{"application/json":{"schema":{"type":"string","example":"Please wait some time, then try again.","uniqueKey":"","typeLabel":"string"},"examples":{"Example":{"title":"Example","value":"Please wait some time, then try again."}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"4254ac2e-858a-4aed-8a7b-fc61a00ece3c":{"api-key":{"type":"apiKey","in":"header","name":"Authorization","description":"API key authentication. Allowed headers-- \"Authorization: ApiKey \u003capi_key>\".","scopes":[]}}},"servers":{"ab5dfd93-1629-49d4-bf05-46d1f1ac4f80":{"url":"https://api.novu.co"},"2865ec2b-d37b-4f89-9008-1b99197b6084":{"url":"https://eu.api.novu.co"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"Authorization","description":"API key authentication. Allowed headers-- \"Authorization: ApiKey \u003capi_key>\".","scopes":[]},"schema":{"title":"Authorization","type":"string","description":"API key authentication. Allowed headers-- \"Authorization: ApiKey \u003capi_key>\".","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"api-key","name":"Authorization"}],"title":"api-key"}]},"originalFileLocation":"openapi.json"},"subdomain":"novu-v2-docs","siteName":"Novu","title":"Update provider credentials - Novu","navMaps":{"firstHrefInVersion":{"v0.24.x":{"href":"/api-reference/subscribers/update-subscriber-credentials","matchLevel":0},"v0.23.0":{"href":"/api-reference/subscribers/update-subscriber-credentials","matchLevel":0},"v0.22.0":{"href":"/api-reference/subscribers/update-subscriber-credentials","matchLevel":0},"v0.21.0":{"href":"/api-reference/subscribers/update-subscriber-credentials","matchLevel":0},"v0.20.0":{"href":"/api-reference/subscribers/update-subscriber-credentials","matchLevel":0},"v0.19.0":{"href":"/api-reference/subscribers/update-subscriber-credentials","matchLevel":0},"v0.18.0":{"href":"/api-reference/subscribers/update-subscriber-credentials","matchLevel":0}},"firstHrefInLanguage":{}},"lastModified":"2026-01-07T02:46:39.837Z","originalFileLocation":"api-reference/subscribers/update-subscriber-credentials.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=\"Update credentials for a provider such as slack and FCM. providerId is required field. This API creates the deviceTokens or replaces the existing ones.\">\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=\"Update provider credentials - Novu\">\u003cmeta data-mint-head property=\"og:description\" content=\"Update credentials for a provider such as slack and FCM. providerId is required field. This API creates the deviceTokens or replaces the existing ones.\">\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/subscribers/update-subscriber-credentials\">\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=\"Update provider credentials - Novu\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Update credentials for a provider such as slack and FCM. providerId is required field. This API creates the deviceTokens or replaces the existing ones.\">\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/subscribers/update-subscriber-credentials\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/subscribers/update-subscriber-credentials.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/subscribers/update-subscriber-credentials#webpage\",\"url\":\"https://v0.x-docs.novu.co/api-reference/subscribers/update-subscriber-credentials\",\"name\":\"Update provider credentials\",\"description\":\"Update credentials for a provider such as slack and FCM. providerId is required field. This API creates the deviceTokens or replaces the existing ones.\",\"dateModified\":\"2026-01-07T02:46:39.837Z\",\"isPartOf\":{\"@id\":\"https://v0.x-docs.novu.co#website\"},\"breadcrumb\":{\"@id\":\"https://v0.x-docs.novu.co/api-reference/subscribers/update-subscriber-credentials#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://v0.x-docs.novu.co/api-reference/subscribers/update-subscriber-credentials#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Subscribers\",\"item\":\"https://v0.x-docs.novu.co/api-reference/subscribers/get-subscribers\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Update provider credentials\",\"item\":\"https://v0.x-docs.novu.co/api-reference/subscribers/update-subscriber-credentials\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://v0.x-docs.novu.co/api-reference/subscribers/update-subscriber-credentials#apireference\",\"headline\":\"Update provider credentials\",\"name\":\"Update provider credentials\",\"description\":\"Update credentials for a provider such as slack and FCM. providerId is required field. This API creates the deviceTokens or replaces the existing ones.\",\"url\":\"https://v0.x-docs.novu.co/api-reference/subscribers/update-subscriber-credentials\",\"mainEntityOfPage\":{\"@id\":\"https://v0.x-docs.novu.co/api-reference/subscribers/update-subscriber-credentials#webpage\"},\"image\":\"https://novu.co/images/social-preview.jpg\",\"dateModified\":\"2026-01-07T02:46:39.837Z\",\"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","href":"/api-reference/overview"},{"title":"API Rate Limiting","href":"/api-reference/rate-limiting"}]},{"group":"Events","pages":[{"openapi":"post /v1/events/trigger","title":"Trigger event","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","description":"Deletes a subscriber entity from the Novu platform","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","description":"Delete subscriber credentials for a provider such as **slack** and **FCM** by **providerId**. \n This action is irreversible and will remove the credentials for the provider for particular **subscriberId**.","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","href":"/api-reference/overview"},{"title":"API Rate Limiting","href":"/api-reference/rate-limiting"}]},{"group":"Events","pages":[{"openapi":"post /v1/events/trigger","title":"Trigger event","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","description":"Deletes a subscriber entity from the Novu platform","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","description":"Delete subscriber credentials for a provider such as **slack** and **FCM** by **providerId**. \n This action is irreversible and will remove the credentials for the provider for particular **subscriberId**.","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","href":"/api-reference/overview"},{"title":"API Rate Limiting","href":"/api-reference/rate-limiting"}]},{"group":"Events","pages":[{"openapi":"post /v1/events/trigger","title":"Trigger event","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","description":"Deletes a subscriber entity from the Novu platform","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","description":"Delete subscriber credentials for a provider such as **slack** and **FCM** by **providerId**. \n This action is irreversible and will remove the credentials for the provider for particular **subscriberId**.","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","href":"/api-reference/overview"},{"title":"API Rate Limiting","href":"/api-reference/rate-limiting"}]},{"group":"Events","pages":[{"openapi":"post /v1/events/trigger","title":"Trigger event","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","description":"Deletes a subscriber entity from the Novu platform","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","description":"Delete subscriber credentials for a provider such as **slack** and **FCM** by **providerId**. \n This action is irreversible and will remove the credentials for the provider for particular **subscriberId**.","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","href":"/api-reference/overview"},{"title":"API Rate Limiting","href":"/api-reference/rate-limiting"}]},{"group":"Events","pages":[{"openapi":"post /v1/events/trigger","title":"Trigger event","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","description":"Deletes a subscriber entity from the Novu platform","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","description":"Delete subscriber credentials for a provider such as **slack** and **FCM** by **providerId**. \n This action is irreversible and will remove the credentials for the provider for particular **subscriberId**.","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","href":"/api-reference/overview"},{"title":"API Rate Limiting","href":"/api-reference/rate-limiting"}]},{"group":"Events","pages":[{"openapi":"post /v1/events/trigger","title":"Trigger event","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","description":"Deletes a subscriber entity from the Novu platform","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","description":"Delete subscriber credentials for a provider such as **slack** and **FCM** by **providerId**. \n This action is irreversible and will remove the credentials for the provider for particular **subscriberId**.","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","href":"/api-reference/overview"},{"title":"API Rate Limiting","href":"/api-reference/rate-limiting"}]},{"group":"Events","pages":[{"openapi":"post /v1/events/trigger","title":"Trigger event","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","description":"Deletes a subscriber entity from the Novu platform","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","description":"Delete subscriber credentials for a provider such as **slack** and **FCM** by **providerId**. \n This action is irreversible and will remove the credentials for the provider for particular **subscriberId**.","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"}]}]},"title":"Update provider credentials - Novu","buildId":"dpl_2xiSHD9XEvLsPGPcfoMtkLTB3dy9","deploymentId":"dpl_2xiSHD9XEvLsPGPcfoMtkLTB3dy9","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DmVyH30O.js","utils-BHQqGGOd.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-CD-E4BIt.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Bp5Lq9Ds.js","snippetPresets-C4xAVCFP.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CgXVLxUC.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BF8I5oUf.js","shallow-Byd0lWnC.js","getApiPlaygroundDisplay-BGOZG1OK.js","CodeSnippet-CpvQL0CY.js","CodeSnippets-B8wkBKXa.js","Page-CBCH2P7b.js","getPastedJson-Ry3scI3Y.js","icon-D7a9HcdD.js","MethodPill-CJ8pmHhz.js","DuplicateIcon-rh1HJF0t.js","createIcon-DvGznqYs.js","DynamicMarkdown-Cc6AuSHS.js","SectionHeading-B4A0S-ep.js","axios-vUo_bRtp.js","Markdown-Cc16CX65.js","clsx-Cs6nMGht.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-zbf22OZA.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-C_fs-y5n.js"]}