The Novu connector lets your AI agent act in each user's Novu account. Each user connects their own Novu API key once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 47 tools.
- Tools
- 47
- What they doRead · write · destructive
- 18 · 20 · 918 read20 write9 destructive
- Users sign in with
- API key
Setup
Install the SDK
Terminal window npm install @scalekit-sdk/node dotenvTerminal window pip install scalekit-sdk-python python-dotenvSet your credentials
Add your Scalekit credentials to your
.envfile. Find values in app.scalekit.com > Developers > API Credentials..env SCALEKIT_ENVIRONMENT_URL=<your-environment-url>SCALEKIT_CLIENT_ID=<your-client-id>SCALEKIT_CLIENT_SECRET=<your-client-secret>Create the Novu connection
In AgentKit > Connections, create a Novu connection. The name you give it is the
connection_nameyour code passes. See Configure connections.Authorize a user and make your first call
quickstart.mts import { ScalekitClient } from '@scalekit-sdk/node'import 'dotenv/config'import { createInterface } from 'node:readline/promises'const scalekit = new ScalekitClient(process.env.SCALEKIT_ENVIRONMENT_URL,process.env.SCALEKIT_CLIENT_ID,process.env.SCALEKIT_CLIENT_SECRET,)const actions = scalekit.actionsconst connector = 'novu'const identifier = 'user_123'// Generate an authorization link for the userconst { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })console.log('Authorize Novu:', link)const rl = createInterface({ input: process.stdin, output: process.stdout })await rl.question('Press Enter after authorizing...')rl.close()// Make your first callconst result = await actions.executeTool({connector,identifier,toolName: 'novu_layouts_list',toolInput: {},})console.log(result)Terminal window npx tsx quickstart.mtsquickstart.py import osfrom scalekit import ScalekitClientfrom dotenv import load_dotenvload_dotenv()scalekit_client = ScalekitClient(env_url=os.getenv("SCALEKIT_ENVIRONMENT_URL"),client_id=os.getenv("SCALEKIT_CLIENT_ID"),client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),)actions = scalekit_client.actionsconnection_name = "novu"identifier = "user_123"# Generate an authorization link for the userlink_response = actions.get_authorization_link(connection_name=connection_name,identifier=identifier,)print("Authorize Novu:", link_response.link)input("Press Enter after authorizing...")# Make your first callresult = actions.execute_tool(tool_input={},tool_name="novu_layouts_list",connection_name=connection_name,identifier=identifier,)print(result)Terminal window python quickstart.pyEach user opens the link once and enters their Novu credentials there. See Authorize a user for the full flow and statuses.
Tools
Pass the exact name toexecute_toolnovu_layout_getFetch details of a specific layout by its unique identifier layoutId Returns an object with data.Read-onlyRetrieve a layout
Fetch details of a specific layout by its unique identifier layoutId Returns an object with data. Use this when you have the ID. Use novu_layouts_list to find one. Needs layoutId from novu_layouts_list.
Inputs
layoutIdstringrequired- The layout ID or identifier. Example: default-layout
novu_layouts_listRetrieve a list of layouts with optional filtering and pagination Returns an object with data.Read-onlyList all layouts
Retrieve a list of layouts with optional filtering and pagination Returns an object with data. Use this to browse. Use novu_layout_get when you already have the ID.
Inputs
limitnumber- Number of items to return per page. Example: 10
offsetnumber- Number of items to skip before starting to return results. Example: 0
orderBystring- Field to sort the results by. Example: createdAtone of
createdAtupdatedAtname orderDirectionstring- Direction of sorting. Example: ASCone of
ASCDESC querystring- Search query to filter layouts. Example: jane
novu_messages_listList all messages for the current environment.Read-onlyList all messages
List all messages for the current environment. This API supports filtering by channel, subscriberId, and transactionId. Returns data, an array of items with _id, _templateId, _environmentId, _messageTemplateId, _organizationId, _notificationId, _subscriberId, subscriber, template, templateIdentifier, plus totalCount, hasMore, pageSize, page.
Inputs
channelstring- Filter by channel: in_app, email, sms, chat or push. Example: emailone of
in_appemailsmschatpushtool contextKeysarray- Filter by exact context keys, order insensitive (format: "type:id") Example: ["tenant:acme"]
limitnumber- Maximum number of items to return. Example: 10
pagenumber- Page number, starting at 0. Example: 0
subscriberIdstring- The subscriber ID you assigned in your system. Example: user-123
transactionIdarray- The transaction ID returned when the event was triggered. Example: 3c7f1a2b-9d4e-4f5a-8b6c-7d8e9f0a1b2c
novu_notification_getRetrieve an event by its unique key identifier notificationId.Read-onlyGet Event
Retrieve an event by its unique key identifier notificationId. Returns an object with data. Use this when you have the ID. Use novu_notifications_list to find one. Needs notificationId from novu_notifications_list.
Inputs
notificationIdstringrequired- The ID of the event (notification). Example: 64f1c2b3a4b5c6d7e8f90a1b
novu_notifications_listList all notification events (triggered events) for the current environment.Read-onlyList Events
List all notification events (triggered events) for the current environment. Returns data, an array of items with _id, _environmentId, _organizationId, _subscriberId, transactionId, _templateId, _digestedNotificationId, createdAt, updatedAt, channels, plus hasMore, pageSize, page. Use this to browse. Use novu_notification_get when you already have the ID.
Inputs
afterstring- Date filter for records after this timestamp. Defaults to earliest date allowed by subscription plan. Example: eyJpZCI6IjEyMyJ9
beforestring- Date filter for records before this timestamp. Defaults to current time of request (now) Example: eyJpZCI6IjEyMyJ9
channelsarray- Array of channel types. Example: ["in_app"]
contextKeysarray- Filter by exact context keys, order insensitive (format: "type:id") Example: ["tenant:acme"]
emailsarray- Array of email addresses or a single email address. Example: ["jane@example.com"]
limitnumber- Limit for pagination. Example: 10
pagenumber- Page number for pagination. Example: 0
searchstring- Search term (deprecated) Example: jane
severityarray- Array of severity levels or a single severity level. Example: ["high"]
subscriberIdsarray- Array of subscriber IDs or a single subscriber ID. Example: ["64f1c2b3a4b5c6d7e8f90a1b"]
subscriptionIdstring- Subscription ID for filtering notifications by subscription. Example: 64f1c2b3a4b5c6d7e8f90a1b
templatesarray- Array of template IDs or a single template ID. Example: ["64f1c2b3a4b5c6d7e8f90a1b"]
topicKeystring- Topic Key for filtering notifications by topic. Example: product-updates
transactionIdstring- The transaction ID to filter by. Example: 64f1c2b3a4b5c6d7e8f90a1b
novu_subscriber_getRetrieve a subscriber by its unique key identifier subscriberId.Read-onlyRetrieve a subscriber
Retrieve a subscriber by its unique key identifier subscriberId. subscriberId field is required. Returns an object with data. Use this when you have the ID. Use novu_subscribers_search to find one. Needs subscriberId from novu_subscribers_search.
Inputs
subscriberIdstringrequired- The identifier of the subscriber. Example: 64f1c2b3a4b5c6d7e8f90a1b
novu_subscriber_notifications_countRetrieve count of in-app (inbox) notifications for a subscriber by its unique key identifier subscriberId.Read-onlyCount Subscriber Inbox Notifications
Retrieve count of in-app (inbox) notifications for a subscriber by its unique key identifier subscriberId. Returns data, an array of items with count, filter. Needs subscriberId from novu_subscribers_search.
Inputs
filtersstringrequired- Array of filter objects (max 30) to count notifications by different criteria. Example: [{"read":false,"archived":false},{"tags":["important"]},{"tags":{"and":[{"or":["a","b"]},{"or":["c"]}]}}]
subscriberIdstringrequired- The identifier of the subscriber. Example: 64f1c2b3a4b5c6d7e8f90a1b
novu_subscriber_notifications_listRetrieve in-app (inbox) notifications for a subscriber by its unique key identifier subscriberId.Read-onlyList Subscriber Inbox Notifications
Retrieve in-app (inbox) notifications for a subscriber by its unique key identifier subscriberId. Returns an object with data. Needs subscriberId from novu_subscribers_search.
Inputs
subscriberIdstringrequired- The identifier of the subscriber. Example: 64f1c2b3a4b5c6d7e8f90a1b
afterstring- Cursor for the next page, from the previous response. Example: 64f1c2b3a4b5c6d7e8f90a1b
archivedboolean- Filter by archived state. Example: false
contextKeysarray- Context keys for filtering notifications in multi-context scenarios. Example: ["tenant:acme"]
createdGtenumber- Filter notifications created on or after this timestamp (Unix timestamp in milliseconds) Example: 1704067200000
createdLtenumber- Filter notifications created on or before this timestamp (Unix timestamp in milliseconds) Example: 1735689599999
datastring- Filter by data attributes (JSON string) Example: {"orderId": "A-1001"}
limitnumber- Maximum number of items to return. Example: 10
offsetnumber- Number of items to skip. Example: 0
readboolean- Filter by read/unread state. Example: false
seenboolean- Filter by seen state. Example: false
severityarray- Filter by severity levels. Example: ["high"]
snoozedboolean- Filter by snoozed state. Example: false
tagsarray- Filter by workflow tags. Returns notifications that have any of the given tags. Example: ["orders"]
novu_subscriber_preferences_getRetrieve subscriber channel preferences by its unique key identifier subscriberId.Read-onlyRetrieve subscriber preferences
Retrieve subscriber channel preferences by its unique key identifier subscriberId. Returns an object with data. Needs subscriberId from novu_subscribers_search.
Inputs
subscriberIdstringrequired- The identifier of the subscriber. Example: 64f1c2b3a4b5c6d7e8f90a1b
contextKeysarray- Context keys for filtering preferences (e.g., ["tenant:acme"]) Example: ["tenant:acme"]
criticalitystring- Which workflows to include by criticality: critical, nonCritical or all. Example: nonCriticalone of
criticalnonCriticalall
novu_subscriber_subscriptions_listRetrieve subscriber's topic subscriptions by its unique key identifier subscriberId.Read-onlyList Subscriber Topic Subscriptions
Retrieve subscriber's topic subscriptions by its unique key identifier subscriberId. Returns an object with data. Needs subscriberId from novu_subscribers_search.
Inputs
subscriberIdstringrequired- The identifier of the subscriber. Example: 64f1c2b3a4b5c6d7e8f90a1b
afterstring- Cursor for pagination indicating the starting point after which to fetch results. Example: eyJpZCI6IjEyMyJ9
beforestring- Cursor for pagination indicating the ending point before which to fetch results. Example: eyJpZCI6IjEyMyJ9
contextKeysarray- Filter by exact context keys, order insensitive (format: "type:id") Example: ["tenant:acme"]
includeCursorboolean- Include cursor item in response. Example: false
keystring- Filter by topic key. Example: welcome-email
limitnumber- Limit the number of items to return (max 100) Example: 10
orderBystring- Field to order by. Example: createdAt
orderDirectionstring- Direction of sorting. Example: ASCone of
ASCDESC
novu_subscribers_searchSearch subscribers by their email, phone, subscriberId and name.Read-onlySearch subscribers
Search subscribers by their email, phone, subscriberId and name. Returns an object with data. Use this to browse. Use novu_subscriber_get when you already have the ID.
Inputs
afterstring- Cursor for pagination indicating the starting point after which to fetch results. Example: eyJpZCI6IjEyMyJ9
beforestring- Cursor for pagination indicating the ending point before which to fetch results. Example: eyJpZCI6IjEyMyJ9
emailstring- Exact email address of the subscriber. The value must match the stored email field. Example: jane@example.com
includeCursorboolean- Include cursor item in response. Example: false
limitnumber- Limit the number of items to return. Example: 10
namestring- Name of the subscriber to filter results. Example: Scalekit test
orderBystring- Field to order by. Example: createdAt
orderDirectionstring- Direction of sorting. Example: ASCone of
ASCDESC phonestring- Exact phone number of the subscriber. The value must match the stored phone field. Example: +14155550123
subscriberIdstring- Unique identifier of the subscriber to filter results. Example: 64f1c2b3a4b5c6d7e8f90a1b
novu_topic_getRetrieve a topic by its unique key identifier topicKey Returns an object with data.Read-onlyRetrieve a topic
Retrieve a topic by its unique key identifier topicKey Returns an object with data. Use this when you have the ID. Use novu_topics_list to find one. Needs topicKey from novu_topics_list.
Inputs
topicKeystringrequired- The key identifier of the topic. Example: product-updates
novu_topic_subscription_getRetrieve a subscription by its unique identifier for a topic.Read-onlyRetrieve a topic subscription
Retrieve a subscription by its unique identifier for a topic. Returns an object with data. Use this when you have the ID. Use novu_topic_subscriptions_list to find one. Needs topicKey from novu_topics_list; identifier from novu_topic_subscriptions_list.
Inputs
identifierstringrequired- The unique identifier of the subscription. Example: user-123
topicKeystringrequired- The key identifier of the topic. Example: product-updates
novu_topic_subscriptions_listList all subscriptions of subscribers for a topic.Read-onlyList topic subscriptions
List all subscriptions of subscribers for a topic. Returns an object with data. Use this to browse. Use novu_topic_subscription_get when you already have the ID. Needs topicKey from novu_topics_list.
Inputs
topicKeystringrequired- The key identifier of the topic. Example: product-updates
afterstring- Cursor for pagination indicating the starting point after which to fetch results. Example: eyJpZCI6IjEyMyJ9
beforestring- Cursor for pagination indicating the ending point before which to fetch results. Example: eyJpZCI6IjEyMyJ9
contextKeysarray- Filter by exact context keys, order insensitive (format: "type:id") Example: ["tenant:acme"]
includeCursorboolean- Include cursor item in response. Example: false
limitnumber- Limit the number of items to return (max 100) Example: 10
orderBystring- Field to order by. Example: createdAt
orderDirectionstring- Direction of sorting. Example: ASCone of
ASCDESC subscriberIdstring- Filter by subscriber ID. Example: 64f1c2b3a4b5c6d7e8f90a1b
novu_topics_listList all topics.Read-onlyList all topics
List all topics. This api returns a paginated list of topics. Topics can be filtered by key, name, or includeCursor to paginate through the list. Returns an object with data. Use this to browse. Use novu_topic_get when you already have the ID.
Inputs
afterstring- Cursor for pagination indicating the starting point after which to fetch results. Example: eyJpZCI6IjEyMyJ9
beforestring- Cursor for pagination indicating the ending point before which to fetch results. Example: eyJpZCI6IjEyMyJ9
includeCursorboolean- Include cursor item in response. Example: false
keystring- Key of the topic to filter results. Example: welcome-email
limitnumber- Limit the number of items to return (max 100) Example: 10
namestring- Name of the topic to filter results. Example: Scalekit test
orderBystring- Field to order by. Example: createdAt
orderDirectionstring- Direction of sorting. Example: ASCone of
ASCDESC
novu_workflow_getFetch details of a specific workflow by its unique identifier workflowId Returns an object with data.Read-onlyRetrieve a workflow
Fetch details of a specific workflow by its unique identifier workflowId Returns an object with data. Use this when you have the ID. Use novu_workflows_list to find one. Needs workflowId from novu_workflows_list.
Inputs
workflowIdstringrequired- The workflow ID or its workflow identifier (slug). Example: order-shipped
environmentIdstring- The environment ID, when reading a workflow from another environment than the key's. Example: 64f1c2b3a4b5c6d7e8f90a1b
novu_workflow_step_getRetrieve data for a specific step in a workflow Returns an object with data.Read-onlyRetrieve workflow step
Retrieve data for a specific step in a workflow Returns an object with data. Needs workflowId from novu_workflows_list.
Inputs
stepIdstringrequired- The step ID or step identifier inside the workflow. Example: email-step
workflowIdstringrequired- The workflow ID or its workflow identifier (slug). Example: order-shipped
novu_workflows_listRetrieve a list of workflows with optional filtering and pagination Returns an object with data.Read-onlyList all workflows
Retrieve a list of workflows with optional filtering and pagination Returns an object with data. Use this to browse. Use novu_workflow_get when you already have the ID.
Inputs
limitnumber- Number of items to return per page. Example: 10
offsetnumber- Number of items to skip before starting to return results. Example: 0
orderBystring- Field to sort the results by. Example: createdAtone of
createdAtupdatedAtnamelastTriggeredAt orderDirectionstring- Direction of sorting. Example: ASCone of
ASCDESC querystring- Search query to filter workflows. Example: jane
statusarray- Filter workflows by status. Example: ["ACTIVE"]
tagsarray- Filter workflows by tags. Example: ["orders"]
novu_event_broadcastTrigger a workflow for every subscriber in the environment at once.WriteBroadcast Event to All Subscribers
Trigger a workflow for every subscriber in the environment at once. Returns acknowledged, status and the transactionId. Use this only for messages meant for everyone. Use novu_event_trigger to target specific subscribers or topics.
Inputs
namestringrequired- The trigger identifier associated for the template you wish to send. This identifier can be found on the template page. Example: Scalekit test
payloadobjectrequired- The payload object is used to pass additional information that could be used to render the template, or perform routing rules based on it. For In-App channel, payload data are also available in. Example: {"comment_id": "string", "post": {"text": "string"}}
actorobject- It is used to display the Avatar of the provided actor's subscriber id or actor object. If a new actor object is provided, we will create a new subscriber in our system. Example: user-456
agentIdstring- Override the workflow-assigned agent for this trigger using the public agent identifier. Omit to use the workflow default; pass null to disable agent routing for this execution. Example: support-agent
contextobject- Optional context (key-value pairs such as tenant or workspace identifiers) that scopes the workflow run and Inbox items. Example: {"tenant": "acme"}
overridesobject- This could be used to override provider specific configurations. Example: {"fcm": {"data": {"key": "value"}}}
tenantobject- It is used to specify a tenant context during trigger event. If a new tenant object is provided, we will create a new tenant. Example: acme
transactionIdstring- A unique identifier for this transaction, we will generated a UUID if not provided. Example: 64f1c2b3a4b5c6d7e8f90a1b
novu_event_triggerTrigger a Novu workflow for one or more recipients (subscriber IDs, subscriber objects or topics), with payload variables for the templates and optional overrides, actor, tenant and context.WriteTrigger Event
Trigger a Novu workflow for one or more recipients (subscriber IDs, subscriber objects or topics), with payload variables for the templates and optional overrides, actor, tenant and context. Returns acknowledged, status and the transactionId of the run. Use this to send one notification. Use novu_events_bulk_trigger for many different triggers in one call, novu_event_broadcast to reach every subscriber, and novu_event_cancel with the transactionId to stop pending steps.
Inputs
namestringrequired- The trigger identifier of the workflow you wish to send. This identifier can be found on the workflow page. Example: workflow_identifier
toarrayrequired- The recipients list of people who will receive the notification. Maximum number of recipients can be 100. Example: SUBSCRIBER_ID
actorobject- It is used to display the Avatar of the provided actor's subscriber id or actor object. If a new actor object is provided, we will create a new subscriber in our system. Example: user-456
agentIdstring- Override the workflow-assigned agent for this trigger using the public agent identifier. Omit to use the workflow default; pass null to disable agent routing for this execution. Example: support-agent
bridgeUrlstring- Optional Bridge Endpoint URL used to route this trigger to a specific Bridge application. Useful during local development when multiple engineers share an organization: set this to your personal tunnel URL from `npx novu@latest dev` (for example via NOVU_BRIDGE_URL) so app-fired triggers hit your machine instead of the environment's synced Bridge URL. Must be a publicly reachable https URL — private or localhost addresses are rejected. Example: https://your-tunnel.novu.co/api/novu
contextobject- Optional context (key-value pairs such as tenant or workspace identifiers) that scopes the workflow run and Inbox items. Example: {"tenant": "acme"}
overridesobject- This could be used to override provider specific configurations. Example: {"fcm": {"data": {"key": "value"}}}
payloadobject- The payload object is used to pass additional custom information that could be used to render the workflow, or perform routing rules based on it. This data will also be available when fetching the notifications feed from the API to display certain parts of the UI. Example: {"comment_id": "string", "post": {"text": "string"}}
tenantobject- It is used to specify a tenant context during trigger event. Existing tenants will be updated with the provided details. Example: acme
transactionIdstring- A unique identifier for deduplication. If the same transactionId is sent again, the trigger is ignored. Useful to prevent duplicate notifications. The retention period depends on your billing tier. Example: 64f1c2b3a4b5c6d7e8f90a1b
novu_events_bulk_triggerUsing this endpoint you can trigger multiple events at once, to avoid multiple calls to the API.WriteBulk Trigger Events
Using this endpoint you can trigger multiple events at once, to avoid multiple calls to the API. Returns data, an array of items with acknowledged, status, error, transactionId, activityFeedLink, jobData.
Inputs
eventsarrayrequired- The events to trigger, each shaped like a single trigger: name (the workflow identifier), to (recipients), and optional payload, overrides, actor and tenant. Up to 100 events. Example: [{"name": "order-shipped", "to": "user-123", "payload": {"orderId": "A-1001"}}]
novu_subscriber_createCreate a subscriber with the subscriber attributes.WriteCreate a subscriber
Create a subscriber with the subscriber attributes. subscriberId is a required field, rest other fields are optional, if the subscriber already exists, it will be updated Returns an object with data.
Inputs
subscriberIdstringrequired- Unique identifier of the subscriber. Example: 64f1c2b3a4b5c6d7e8f90a1b
avatarstring- Avatar URL or identifier. Example: https://example.com/avatar.jpg
dataobject- Additional custom data associated with the subscriber. Example: {"company": "Acme", "plan": "enterprise"}
emailstring- Email address of the subscriber. Example: john.doe@example.com
failIfExistsboolean- If true, the request will fail if a subscriber with the same subscriberId already exists. Example: false
firstNamestring- First name of the subscriber. Example: John
lastNamestring- Last name of the subscriber. Example: Doe
localestring- Locale of the subscriber. Example: en-US
phonestring- Phone number of the subscriber. Example: +1234567890
timezonestring- Timezone of the subscriber. Example: America/New_York
novu_subscriber_credentials_upsertUpsert credentials for a provider such as slack and FCM.WriteUpsert Subscriber Provider Credentials
Upsert credentials for a provider such as slack and FCM. providerId is required field. Returns an object with data. Only the fields you pass change; omitted fields keep their current values.
Inputs
credentialsobjectrequired- Credentials payload for the specified provider. Example: {"webhookUrl": "https://example.com/webhook", "channel": "general"}
providerIdstringrequired- The provider identifier for the credentials. Example: slackone of
slackdiscordgoogle-chatmsteamswebex-messagingmattermostryverzulipgrafana-on-callgetstreamrocket-chatwhatsapp-businesslinechat-webhooknovu-slacktelegramsendbluephoton-imessagenovu-web-chatfcmapnsexpoone-signalpushpadpush-webhookpusher-beamsappio subscriberIdstringrequired- The subscriber ID you assigned in your system. Example: user-123
integrationIdentifierstring- The integration identifier. Example: slack-workspace
novu_subscriber_notification_archiveArchive a specific in-app (inbox) notification by its unique identifier notificationId.WriteArchive Inbox Notification
Archive a specific in-app (inbox) notification by its unique identifier notificationId. Returns an object with id, transactionId, subject, body, to, isRead, isSeen, isArchived, isSnoozed, snoozedUntil, deliveredAt, createdAt and more. Only the fields you pass change; omitted fields keep their current values. Needs subscriberId from novu_subscribers_search; notificationId from novu_subscriber_notifications_list.
Inputs
notificationIdstringrequired- The identifier of the notification. Example: 64f1c2b3a4b5c6d7e8f90a1b
subscriberIdstringrequired- The identifier of the subscriber. Example: 64f1c2b3a4b5c6d7e8f90a1b
contextKeysarray- Context keys for filtering. Example: ["tenant:acme"]
novu_subscriber_notification_mark_readMark a specific in-app (inbox) notification as read by its unique identifier notificationId.WriteMark Inbox Notification Read
Mark a specific in-app (inbox) notification as read by its unique identifier notificationId. Returns an object with id, transactionId, subject, body, to, isRead, isSeen, isArchived, isSnoozed, snoozedUntil, deliveredAt, createdAt and more. Only the fields you pass change; omitted fields keep their current values. Needs subscriberId from novu_subscribers_search; notificationId from novu_subscriber_notifications_list.
Inputs
notificationIdstringrequired- The identifier of the notification. Example: 64f1c2b3a4b5c6d7e8f90a1b
subscriberIdstringrequired- The identifier of the subscriber. Example: 64f1c2b3a4b5c6d7e8f90a1b
contextKeysarray- Context keys for filtering. Example: ["tenant:acme"]
novu_subscriber_notification_mark_unreadMark a specific in-app (inbox) notification as unread by its unique identifier notificationId.WriteMark Inbox Notification Unread
Mark a specific in-app (inbox) notification as unread by its unique identifier notificationId. Returns an object with id, transactionId, subject, body, to, isRead, isSeen, isArchived, isSnoozed, snoozedUntil, deliveredAt, createdAt and more. Only the fields you pass change; omitted fields keep their current values. Needs subscriberId from novu_subscribers_search; notificationId from novu_subscriber_notifications_list.
Inputs
notificationIdstringrequired- The identifier of the notification. Example: 64f1c2b3a4b5c6d7e8f90a1b
subscriberIdstringrequired- The identifier of the subscriber. Example: 64f1c2b3a4b5c6d7e8f90a1b
contextKeysarray- Context keys for filtering. Example: ["tenant:acme"]
novu_subscriber_notification_unarchiveUnarchive a specific in-app (inbox) notification by its unique identifier notificationId.WriteUnarchive Inbox Notification
Unarchive a specific in-app (inbox) notification by its unique identifier notificationId. Returns an object with id, transactionId, subject, body, to, isRead, isSeen, isArchived, isSnoozed, snoozedUntil, deliveredAt, createdAt and more. Only the fields you pass change; omitted fields keep their current values. Needs subscriberId from novu_subscribers_search; notificationId from novu_subscriber_notifications_list.
Inputs
notificationIdstringrequired- The identifier of the notification. Example: 64f1c2b3a4b5c6d7e8f90a1b
subscriberIdstringrequired- The identifier of the subscriber. Example: 64f1c2b3a4b5c6d7e8f90a1b
contextKeysarray- Context keys for filtering. Example: ["tenant:acme"]
novu_subscriber_notifications_mark_all_readMark all in-app (inbox) notifications matching the specified filters as read.WriteMark All Inbox Notifications Read
Mark all in-app (inbox) notifications matching the specified filters as read. Returns an empty response on success (HTTP 204). Needs subscriberId from novu_subscribers_search.
Inputs
subscriberIdstringrequired- The identifier of the subscriber. Example: 64f1c2b3a4b5c6d7e8f90a1b
contextKeysarray- Context keys for filtering notifications. Example: ["tenant:acme"]
datastring- Filter notifications by data attributes (JSON string) Example: {"orderId": "A-1001"}
tagsarray- Filter by workflow tags: an array of tags matches any of them (OR); an object {"and": [{"or": [...]}, ...]} matches an AND of OR-groups. Example: ["orders"]
novu_subscriber_notifications_mark_seenMark specific and multiple in-app (inbox) notifications as seen.WriteMark Inbox Notifications Seen
Mark specific and multiple in-app (inbox) notifications as seen. Returns an empty response on success (HTTP 204). Needs subscriberId from novu_subscribers_search.
Inputs
subscriberIdstringrequired- The identifier of the subscriber. Example: 64f1c2b3a4b5c6d7e8f90a1b
contextKeysarray- Context keys for filtering notifications. Example: ["tenant:acme"]
datastring- Filter notifications by data attributes (JSON string) Example: {"orderId": "A-1001"}
notificationIdsarray- Specific notification IDs to mark as seen. Example: ["64f1c2b3a4b5c6d7e8f90a1b"]
tagsarray- Filter by workflow tags: an array of tags matches any of them (OR); an object {"and": [{"or": [...]}, ...]} matches an AND of OR-groups. Example: ["orders"]
novu_subscriber_preferences_updateUpdate subscriber preferences by its unique key identifier subscriberId.WriteUpdate subscriber preferences
Update subscriber preferences by its unique key identifier subscriberId. workflowId is optional field, if provided, this API will update that workflow preference, otherwise it will update global preferences Returns an object with data. Only the fields you pass change; omitted fields keep their current values. Needs subscriberId from novu_subscribers_search.
Inputs
subscriberIdstringrequired- The identifier of the subscriber. Example: 64f1c2b3a4b5c6d7e8f90a1b
channelsobject- Channel-specific preference settings. Example: {"email": false, "sms": false}
contextobject- Optional context (key-value pairs such as tenant or workspace identifiers) that scopes the workflow run and Inbox items. Example: {"tenant": "acme"}
scheduleobject- Subscriber schedule. Example: {"isEnabled": true}
workflowIdstring- Workflow internal _id, identifier or slug. If provided, update workflow specific preferences, otherwise update global preferences. Example: order-shipped
novu_subscriber_updateUpdate a subscriber by its unique key identifier subscriberId.WriteUpdate a subscriber
Update a subscriber by its unique key identifier subscriberId. subscriberId is a required field, rest other fields are optional Returns an object with data. Only the fields you pass change; omitted fields keep their current values. Needs subscriberId from novu_subscribers_search.
Inputs
subscriberIdstringrequired- The identifier of the subscriber. Example: 64f1c2b3a4b5c6d7e8f90a1b
avatarstring- Avatar URL or identifier. Example: https://example.com/avatar.jpg
dataobject- Additional custom data associated with the subscriber. Example: {"company": "Acme", "plan": "enterprise"}
emailstring- Email address of the subscriber. Example: john.doe@example.com
firstNamestring- First name of the subscriber. Example: John
lastNamestring- Last name of the subscriber. Example: Doe
localestring- Locale of the subscriber. Example: en-US
phonestring- Phone number of the subscriber. Example: +1234567890
timezonestring- Timezone of the subscriber. Example: America/New_York
novu_subscribers_bulk_createUsing this endpoint multiple subscribers can be created at once.WriteBulk create subscribers
Using this endpoint multiple subscribers can be created at once. Returns an object with data.
Inputs
subscribersarrayrequired- An array of subscribers to be created in bulk. Example: [{"subscriberId": "64f1c2b3a4b5c6d7e8f90a1b"}]
novu_topic_subscriptions_createCreate topic subscriptions.WriteCreate topic subscriptions
Create topic subscriptions. This api will create subscription for subscriberIds for a topic. Returns an object with data. Needs topicKey from novu_topics_list.
Inputs
topicKeystringrequired- The key identifier of the topic. Example: product-updates
contextobject- Optional context (key-value pairs such as tenant or workspace identifiers) that scopes the workflow run and Inbox items. Example: {"tenant": "acme"}
namestring- The name of the topic. Example: My Topic
preferencesarray- The preferences of the topic. Can be a simple workflow ID string, workflow preference object, or group filter object. Example: [{"workflowId": "workflow-123", "condition": {"===": [{"var": "payload.tier"}, "premium"]}}]
subscriberIdsarray- List of subscriber IDs to subscribe to the topic (max: 100). @deprecated Use the "subscriptions" property instead. Example: ["subscriberId1", "subscriberId2"]
subscriptionsarray- List of subscriptions to subscribe to the topic (max: 100). Can be either a string array of subscriber IDs or an array of objects with identifier and subscriberId. Example: [{"identifier": "subscriber-123-subscription-a", "subscriberId": "subscriber-123"}, {"identifier": "subscriber-456-subscription-b", "subscriberId": "subscriber-456"}]
novu_topic_updateUpdate a topic name or data by its unique key identifier topicKey Returns an object with data.WriteUpdate a topic
Update a topic name or data by its unique key identifier topicKey Returns an object with data. Only the fields you pass change; omitted fields keep their current values. Needs topicKey from novu_topics_list.
Inputs
topicKeystringrequired- The key identifier of the topic. Example: product-updates
dataobject- Additional custom data associated with the topic. Flat key-value pairs of scalars (string, number, boolean, string[]). Maximum size: 64KB. Pass null to clear. Example: {"company": "Acme", "plan": "enterprise"}
namestring- The display name for the topic. Example: Updated Topic Name
novu_topic_upsertCreate a new topic if it does not exist, or updates an existing topic if it already exists.WriteCreate or Update Topic
Create a new topic if it does not exist, or updates an existing topic if it already exists. Returns an object with data.
Inputs
keystringrequired- The unique key identifier for the topic. The key must contain only alphanumeric characters (a-z, A-Z, 0-9), hyphens (-), underscores (_), colons (:), or be a valid email address. Example: task:12345
dataobject- Additional custom data associated with the topic. Flat key-value pairs of scalars (string, number, boolean, string[]). Maximum size: 64KB. Example: {"company": "Acme", "plan": "enterprise"}
failIfExistsboolean- If true, the request will fail if a topic with the same key already exists. Example: false
namestring- The display name for the topic. Example: Task Title
novu_workflow_createCreate a new workflow in the Novu Cloud environment Returns an object with data.WriteCreate a workflow
Create a new workflow in the Novu Cloud environment Returns an object with data.
Inputs
namestringrequired- Name of the workflow. Example: Scalekit test
stepsarrayrequired- Steps of the workflow. Example: [{"name": "Scalekit test", "type": "in_app"}]
workflowIdstringrequired- Unique identifier for the workflow. Example: order-shipped
__sourcestring- Source of workflow creation. Example: editorone of
template_storeeditornotification_directoryonboarding_digest_demoonboarding_in_appempty_statedropdownonboarding_get_startedbridgedashboardai activeboolean- Whether the workflow is active. Example: false
descriptionstring- Description of the workflow. Example: Created by the Scalekit connector
isTranslationEnabledboolean- Enable or disable translations for this workflow. Example: false
payloadSchemaobject- The payload JSON Schema for the workflow. Example: {"type": "object", "properties": {"orderId": {"type": "string"}}}
preferencesobject- Workflow preferences. Example: {"user": {"all": {"enabled": true, "readOnly": false}, "channels": {"email": {"enabled": true}, "sms": {"enabled": false}}}, "workflow": {"all": {"enabled": true, "readOnly": false}, "channels": {"email": {"enabled": true}, "sms": {"enabled": false}}}}
severitystring- Severity of the workflow. Example: highone of
highmediumlownone tagsarray- Tags associated with the workflow. Example: ["orders"]
validatePayloadboolean- Enable or disable payload schema validation. Example: false
novu_workflow_patchPartially updates a workflow by its unique identifier workflowId Returns an object with data.WritePatch Workflow
Partially updates a workflow by its unique identifier workflowId Returns an object with data. Only the fields you pass change; omitted fields keep their current values. Needs workflowId from novu_workflows_list.
Inputs
workflowIdstringrequired- The workflow ID or its workflow identifier (slug). Example: order-shipped
activeboolean- Activate or deactivate the workflow. Example: false
descriptionstring- Updated description of the workflow. Example: Created by the Scalekit connector
isTranslationEnabledboolean- Enable or disable translations for this workflow. Example: false
namestring- New name for the workflow. Example: Scalekit test
payloadSchemaobject- The payload JSON Schema for the workflow. Example: {"type": "object", "properties": {"orderId": {"type": "string"}}}
tagsarray- Tags associated with the workflow. Example: ["orders"]
validatePayloadboolean- Enable or disable payload schema validation. Example: false
novu_workflow_updateUpdate the details of an existing workflow, here workflowId is the identifier of the workflow Returns an object with data.WriteUpdate Workflow
Update the details of an existing workflow, here workflowId is the identifier of the workflow Returns an object with data. The request replaces the stored value with what you send. Needs workflowId from novu_workflows_list.
- Idempotent
Inputs
namestringrequired- Name of the workflow. Example: Scalekit test
preferencesobjectrequired- Workflow preferences. Example: {"user": {"all": {"enabled": true, "readOnly": false}, "channels": {"email": {"enabled": true}, "sms": {"enabled": false}}}, "workflow": {"all": {"enabled": true, "readOnly": false}, "channels": {"email": {"enabled": true}, "sms": {"enabled": false}}}}
stepsarrayrequired- Steps of the workflow. Example: [{"name": "Scalekit test", "type": "in_app"}]
workflowIdstringrequired- The workflow ID or its workflow identifier (slug). Example: order-shipped
activeboolean- Whether the workflow is active. Example: false
body_workflowIdstring- Workflow ID (allowed only for code-first workflows) Example: Hello from Scalekit
descriptionstring- Description of the workflow. Example: Created by the Scalekit connector
isTranslationEnabledboolean- Enable or disable translations for this workflow. Example: false
originstring- Origin of the workflow. Accepted for backwards compatibility but ignored on update. Example: novu-cloudone of
novu-cloudnovu-cloud-v1external payloadSchemaobject- The payload JSON Schema for the workflow. Example: {"type": "object", "properties": {"orderId": {"type": "string"}}}
severitystring- Severity of the workflow. Example: highone of
highmediumlownone tagsarray- Tags associated with the workflow. Example: ["orders"]
validatePayloadboolean- Enable or disable payload schema validation. Example: false
novu_event_cancelCancel a triggered event by its transactionId, stopping any steps that have not run yet (such as delayed or digested messages).DestructiveCancel Triggered Event
Cancel a triggered event by its transactionId, stopping any steps that have not run yet (such as delayed or digested messages). Returns true when pending jobs were cancelled. Use the transactionId returned by novu_event_trigger. Messages already sent are not recalled.
- Idempotent
Inputs
transactionIdstringrequired- The transaction ID returned when the event was triggered. Example: 3c7f1a2b-9d4e-4f5a-8b6c-7d8e9f0a1b2c
novu_message_deleteDelete a message entity from the Novu platform by messageId.DestructiveDelete a message
Delete a message entity from the Novu platform by messageId. Returns an object with data. Needs messageId from novu_messages_list.
- Idempotent
Inputs
messageIdstringrequired- The message ID. Example: 64f1c2b3a4b5c6d7e8f90a1b
novu_messages_delete_by_transactionDelete multiple messages from the Novu platform using transactionId of triggered event.DestructiveDelete Messages by Transaction
Delete multiple messages from the Novu platform using transactionId of triggered event. Returns an empty response on success (HTTP 204).
- Idempotent
Inputs
transactionIdstringrequired- The transaction ID returned when the event was triggered. Example: 3c7f1a2b-9d4e-4f5a-8b6c-7d8e9f0a1b2c
channelstring- The channel of the message to be deleted. Example: in_appone of
in_appemailsmschatpushtool
novu_subscriber_credentials_deleteDelete subscriber credentials for a provider such as slack and FCM by providerId.DestructiveDelete Subscriber Provider Credentials
Delete subscriber credentials for a provider such as slack and FCM by providerId. Returns an empty response on success (HTTP 204).
- Idempotent
Inputs
providerIdstringrequired- The chat or push provider whose credentials to delete, such as slack, discord, fcm or apns. Example: slack
subscriberIdstringrequired- The subscriber ID you assigned in your system. Example: user-123
novu_subscriber_deleteDelete a subscriber entity from the Novu platform along with associated messages, preferences, and topic subscriptions.DestructiveDelete a subscriber
Delete a subscriber entity from the Novu platform along with associated messages, preferences, and topic subscriptions. subscriberId is a required field. Returns an object with data. Needs subscriberId from novu_subscribers_search.
- Idempotent
Inputs
subscriberIdstringrequired- The identifier of the subscriber. Example: 64f1c2b3a4b5c6d7e8f90a1b
novu_subscriber_notification_deleteDelete a specific in-app (inbox) notification permanently by its unique identifier notificationId.DestructiveDelete Inbox Notification
Delete a specific in-app (inbox) notification permanently by its unique identifier notificationId. Returns an empty response on success (HTTP 204). Needs subscriberId from novu_subscribers_search; notificationId from novu_subscriber_notifications_list.
- Idempotent
Inputs
notificationIdstringrequired- The identifier of the notification. Example: 64f1c2b3a4b5c6d7e8f90a1b
subscriberIdstringrequired- The identifier of the subscriber. Example: 64f1c2b3a4b5c6d7e8f90a1b
contextKeysarray- Context keys for filtering. Example: ["tenant:acme"]
novu_topic_deleteDelete a topic by its unique key identifier topicKey.DestructiveDelete a topic
Delete a topic by its unique key identifier topicKey. Returns an object with data. Needs topicKey from novu_topics_list.
- Idempotent
Inputs
topicKeystringrequired- The key identifier of the topic. Example: product-updates
novu_topic_subscriptions_deleteDelete subscriptions for subscriberIds for a topic.DestructiveDelete topic subscriptions
Delete subscriptions for subscriberIds for a topic. Returns data, an array of items with _id, identifier, topic, subscriber, contextKeys, createdAt, updatedAt, plus meta, errors. Needs topicKey from novu_topics_list.
- Idempotent
Inputs
topicKeystringrequired- The key identifier of the topic. Example: product-updates
subscriberIdsarray- List of subscriber identifiers to unsubscribe from the topic (max: 100). @deprecated Use the "subscriptions" property instead. Example: ["subscriberId1", "subscriberId2"]
subscriptionsarray- List of subscriptions to unsubscribe from the topic (max: 100). Can be either a string array of subscriber IDs or an array of objects with identifier and/or subscriberId. If only subscriberId is provided, all subscriptions for that subscriber within the topic will be deleted. Example: [{"identifier": "subscriber-123-subscription-a", "subscriberId": "subscriber-123"}, {"subscriberId": "subscriber-456"}, {"identifier": "subscriber-789-subscription-b"}]
novu_workflow_deleteRemove a specific workflow by its unique identifier workflowId Returns an empty response on success (HTTP 204).DestructiveDelete a workflow
Remove a specific workflow by its unique identifier workflowId Returns an empty response on success (HTTP 204). Needs workflowId from novu_workflows_list.
- Idempotent
Inputs
workflowIdstringrequired- The workflow ID or its workflow identifier (slug). Example: order-shipped
No tools match.