> **Building with AI coding agents?** Install the authstack plugin with one command. This equips your agent with accurate Scalekit implementation patterns.
>
> **Recommended** (the `-y` flags skip prompts, so the command runs without an interactive terminal):
> ```bash
> npx -y @scalekit-inc/cli setup -y
> ```
>
> Global:
> ```bash
> npm install -g @scalekit-inc/cli
> scalekit setup -y
> ```
>
> Supports Claude Code, Cursor, GitHub Copilot, Codex + skills for other Agent Skills-compatible agents in `~/.agents/skills`.
> Skills: integrate-agentkit, implement-saaskit, add-mcp-oauth, implement-sso, implement-scim.
> [Full setup guide](https://docs.scalekit.com/dev-kit/build-with-ai/)

---

# Connect AI agents to Novu

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.

**Authentication:** API Key
**Categories:** Communication, Developer Tools
**Tools:** 47: 18 read, 20 write, 9 destructive
**Users sign in with:** API key
**Built by:** Scalekit connector
**Try it:** [Playground in the Scalekit dashboard](https://app.scalekit.com/ws/signup?sk_intent=playground&provider=NOVU)

## Setup

1. ### Install the SDK

   **Node.js**

   ```bash
   npm install @scalekit-sdk/node dotenv
   ```

   **Python**

   ```bash
   pip install scalekit-sdk-python python-dotenv
   ```

2. ### Set your credentials

   Add your Scalekit credentials to your `.env` file. Find values in **[app.scalekit.com](https://app.scalekit.com)** > **Developers** > **API Credentials**.

   ```sh title=".env"
   SCALEKIT_ENVIRONMENT_URL=<your-environment-url>
   SCALEKIT_CLIENT_ID=<your-client-id>
   SCALEKIT_CLIENT_SECRET=<your-client-secret>
   ```

3. ### Create the Novu connection

   In **AgentKit > Connections**, create a Novu connection. The name you give it is the `connection_name` your code passes. See [Configure connections](/agentkit/connections/).

4. ### Authorize a user and make your first call

   **Node.js** (`quickstart.mts`)

   ```typescript
   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.actions

   const connector = 'novu'
   const identifier = 'user_123'

   // Generate an authorization link for the user
   const { 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 call
   const result = await actions.executeTool({
     connector,
     identifier,
     toolName: 'novu_layouts_list',
     toolInput: {},
   })
   console.log(result)
   ```

   ```bash
   npx tsx quickstart.mts
   ```

   **Python** (`quickstart.py`)

   ```python
   import os
   from scalekit import ScalekitClient
   from dotenv import load_dotenv
   load_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.actions

   connection_name = "novu"
   identifier = "user_123"

   # Generate an authorization link for the user
   link_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 call
   result = actions.execute_tool(
       tool_input={},
       tool_name="novu_layouts_list",
       connection_name=connection_name,
       identifier=identifier,
   )
   print(result)
   ```

   ```bash
   python quickstart.py
   ```

   Each user opens the link once and enters their Novu credentials there. See [Authorize a user](/agentkit/tools/authorize/) for the full flow and statuses.

## Tools

Pass the exact name to `execute_tool`, with an input like each tool's example. To ask for a tool that's missing, use the [request form](https://scalekitsupport.portal.usepylon.com/forms/request-a-connector-tool).

**Node.js**

```typescript
const result = await actions.executeTool({
  toolName: 'novu_layout_get',
  toolInput: {
    layoutId: '<layoutId>',
  },
  connector: 'novu',
  identifier: 'user_123',
})
```

**Python**

```python
result = actions.execute_tool(
    tool_name="novu_layout_get",
    tool_input={
        "layoutId": "<layoutId>",
    },
    connection_name="novu",
    identifier="user_123",
)
```

`result.data` is the app's response as JSON, and `result.execution_id` (`executionId` in Node.js) is the ID of the call.

### `novu_layout_get`

Retrieve a layout · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `layoutId` (`string`, required): The layout ID or identifier. Example: default-layout

Example input: `{"layoutId":"<layoutId>"}`

### `novu_layouts_list`

List all layouts · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `limit` (`number`, optional): Number of items to return per page. Example: 10
- `offset` (`number`, optional): Number of items to skip before starting to return results. Example: 0
- `orderBy` (`string`, optional): Field to sort the results by. Example: createdAt. One of: `createdAt`, `updatedAt`, `name`.
- `orderDirection` (`string`, optional): Direction of sorting. Example: ASC. One of: `ASC`, `DESC`.
- `query` (`string`, optional): Search query to filter layouts. Example: jane

Example input: `{}`

### `novu_messages_list`

List all messages · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `channel` (`string`, optional): Filter by channel: in_app, email, sms, chat or push. Example: email. One of: `in_app`, `email`, `sms`, `chat`, `push`, `tool`.
- `contextKeys` (`array`, optional): Filter by exact context keys, order insensitive (format: "type:id") Example: ["tenant:acme"]
- `limit` (`number`, optional): Maximum number of items to return. Example: 10
- `page` (`number`, optional): Page number, starting at 0. Example: 0
- `subscriberId` (`string`, optional): The subscriber ID you assigned in your system. Example: user-123
- `transactionId` (`array`, optional): The transaction ID returned when the event was triggered. Example: 3c7f1a2b-9d4e-4f5a-8b6c-7d8e9f0a1b2c

Example input: `{}`

### `novu_notification_get`

Get Event · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `notificationId` (`string`, required): The ID of the event (notification). Example: 64f1c2b3a4b5c6d7e8f90a1b

Example input: `{"notificationId":"<notificationId>"}`

### `novu_notifications_list`

List Events · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `after` (`string`, optional): Date filter for records after this timestamp. Defaults to earliest date allowed by subscription plan. Example: eyJpZCI6IjEyMyJ9
- `before` (`string`, optional): Date filter for records before this timestamp. Defaults to current time of request (now) Example: eyJpZCI6IjEyMyJ9
- `channels` (`array`, optional): Array of channel types. Example: ["in_app"]
- `contextKeys` (`array`, optional): Filter by exact context keys, order insensitive (format: "type:id") Example: ["tenant:acme"]
- `emails` (`array`, optional): Array of email addresses or a single email address. Example: ["jane@example.com"]
- `limit` (`number`, optional): Limit for pagination. Example: 10
- `page` (`number`, optional): Page number for pagination. Example: 0
- `search` (`string`, optional): Search term (deprecated) Example: jane
- `severity` (`array`, optional): Array of severity levels or a single severity level. Example: ["high"]
- `subscriberIds` (`array`, optional): Array of subscriber IDs or a single subscriber ID. Example: ["64f1c2b3a4b5c6d7e8f90a1b"]
- `subscriptionId` (`string`, optional): Subscription ID for filtering notifications by subscription. Example: 64f1c2b3a4b5c6d7e8f90a1b
- `templates` (`array`, optional): Array of template IDs or a single template ID. Example: ["64f1c2b3a4b5c6d7e8f90a1b"]
- `topicKey` (`string`, optional): Topic Key for filtering notifications by topic. Example: product-updates
- `transactionId` (`string`, optional): The transaction ID to filter by. Example: 64f1c2b3a4b5c6d7e8f90a1b

Example input: `{}`

### `novu_subscriber_get`

Retrieve a subscriber · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `subscriberId` (`string`, required): The identifier of the subscriber. Example: 64f1c2b3a4b5c6d7e8f90a1b

Example input: `{"subscriberId":"<subscriberId>"}`

### `novu_subscriber_notifications_count`

Count Subscriber Inbox Notifications · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `filters` (`string`, required): 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"]}]}}]
- `subscriberId` (`string`, required): The identifier of the subscriber. Example: 64f1c2b3a4b5c6d7e8f90a1b

Example input: `{"filters":"<filters>","subscriberId":"<subscriberId>"}`

### `novu_subscriber_notifications_list`

List Subscriber Inbox Notifications · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `subscriberId` (`string`, required): The identifier of the subscriber. Example: 64f1c2b3a4b5c6d7e8f90a1b
- `after` (`string`, optional): Cursor for the next page, from the previous response. Example: 64f1c2b3a4b5c6d7e8f90a1b
- `archived` (`boolean`, optional): Filter by archived state. Example: false
- `contextKeys` (`array`, optional): Context keys for filtering notifications in multi-context scenarios. Example: ["tenant:acme"]
- `createdGte` (`number`, optional): Filter notifications created on or after this timestamp (Unix timestamp in milliseconds) Example: 1704067200000
- `createdLte` (`number`, optional): Filter notifications created on or before this timestamp (Unix timestamp in milliseconds) Example: 1735689599999
- `data` (`string`, optional): Filter by data attributes (JSON string) Example: {"orderId": "A-1001"}
- `limit` (`number`, optional): Maximum number of items to return. Example: 10
- `offset` (`number`, optional): Number of items to skip. Example: 0
- `read` (`boolean`, optional): Filter by read/unread state. Example: false
- `seen` (`boolean`, optional): Filter by seen state. Example: false
- `severity` (`array`, optional): Filter by severity levels. Example: ["high"]
- `snoozed` (`boolean`, optional): Filter by snoozed state. Example: false
- `tags` (`array`, optional): Filter by workflow tags. Returns notifications that have any of the given tags. Example: ["orders"]

Example input: `{"subscriberId":"<subscriberId>"}`

### `novu_subscriber_preferences_get`

Retrieve subscriber preferences · Read-only

Retrieve subscriber channel preferences by its unique key identifier subscriberId.
Returns an object with data.
Needs subscriberId from novu_subscribers_search.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `subscriberId` (`string`, required): The identifier of the subscriber. Example: 64f1c2b3a4b5c6d7e8f90a1b
- `contextKeys` (`array`, optional): Context keys for filtering preferences (e.g., ["tenant:acme"]) Example: ["tenant:acme"]
- `criticality` (`string`, optional): Which workflows to include by criticality: critical, nonCritical or all. Example: nonCritical. One of: `critical`, `nonCritical`, `all`.

Example input: `{"subscriberId":"<subscriberId>"}`

### `novu_subscriber_subscriptions_list`

List Subscriber Topic Subscriptions · Read-only

Retrieve subscriber's topic subscriptions by its unique key identifier subscriberId.
Returns an object with data.
Needs subscriberId from novu_subscribers_search.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `subscriberId` (`string`, required): The identifier of the subscriber. Example: 64f1c2b3a4b5c6d7e8f90a1b
- `after` (`string`, optional): Cursor for pagination indicating the starting point after which to fetch results. Example: eyJpZCI6IjEyMyJ9
- `before` (`string`, optional): Cursor for pagination indicating the ending point before which to fetch results. Example: eyJpZCI6IjEyMyJ9
- `contextKeys` (`array`, optional): Filter by exact context keys, order insensitive (format: "type:id") Example: ["tenant:acme"]
- `includeCursor` (`boolean`, optional): Include cursor item in response. Example: false
- `key` (`string`, optional): Filter by topic key. Example: welcome-email
- `limit` (`number`, optional): Limit the number of items to return (max 100) Example: 10
- `orderBy` (`string`, optional): Field to order by. Example: createdAt
- `orderDirection` (`string`, optional): Direction of sorting. Example: ASC. One of: `ASC`, `DESC`.

Example input: `{"subscriberId":"<subscriberId>"}`

### `novu_subscribers_search`

Search subscribers · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `after` (`string`, optional): Cursor for pagination indicating the starting point after which to fetch results. Example: eyJpZCI6IjEyMyJ9
- `before` (`string`, optional): Cursor for pagination indicating the ending point before which to fetch results. Example: eyJpZCI6IjEyMyJ9
- `email` (`string`, optional): Exact email address of the subscriber. The value must match the stored email field. Example: jane@example.com
- `includeCursor` (`boolean`, optional): Include cursor item in response. Example: false
- `limit` (`number`, optional): Limit the number of items to return. Example: 10
- `name` (`string`, optional): Name of the subscriber to filter results. Example: Scalekit test
- `orderBy` (`string`, optional): Field to order by. Example: createdAt
- `orderDirection` (`string`, optional): Direction of sorting. Example: ASC. One of: `ASC`, `DESC`.
- `phone` (`string`, optional): Exact phone number of the subscriber. The value must match the stored phone field. Example: +14155550123
- `subscriberId` (`string`, optional): Unique identifier of the subscriber to filter results. Example: 64f1c2b3a4b5c6d7e8f90a1b

Example input: `{}`

### `novu_topic_get`

Retrieve a topic · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `topicKey` (`string`, required): The key identifier of the topic. Example: product-updates

Example input: `{"topicKey":"<topicKey>"}`

### `novu_topic_subscription_get`

Retrieve a topic subscription · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `identifier` (`string`, required): The unique identifier of the subscription. Example: user-123
- `topicKey` (`string`, required): The key identifier of the topic. Example: product-updates

Example input: `{"identifier":"<identifier>","topicKey":"<topicKey>"}`

### `novu_topic_subscriptions_list`

List topic subscriptions · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `topicKey` (`string`, required): The key identifier of the topic. Example: product-updates
- `after` (`string`, optional): Cursor for pagination indicating the starting point after which to fetch results. Example: eyJpZCI6IjEyMyJ9
- `before` (`string`, optional): Cursor for pagination indicating the ending point before which to fetch results. Example: eyJpZCI6IjEyMyJ9
- `contextKeys` (`array`, optional): Filter by exact context keys, order insensitive (format: "type:id") Example: ["tenant:acme"]
- `includeCursor` (`boolean`, optional): Include cursor item in response. Example: false
- `limit` (`number`, optional): Limit the number of items to return (max 100) Example: 10
- `orderBy` (`string`, optional): Field to order by. Example: createdAt
- `orderDirection` (`string`, optional): Direction of sorting. Example: ASC. One of: `ASC`, `DESC`.
- `subscriberId` (`string`, optional): Filter by subscriber ID. Example: 64f1c2b3a4b5c6d7e8f90a1b

Example input: `{"topicKey":"<topicKey>"}`

### `novu_topics_list`

List all topics · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `after` (`string`, optional): Cursor for pagination indicating the starting point after which to fetch results. Example: eyJpZCI6IjEyMyJ9
- `before` (`string`, optional): Cursor for pagination indicating the ending point before which to fetch results. Example: eyJpZCI6IjEyMyJ9
- `includeCursor` (`boolean`, optional): Include cursor item in response. Example: false
- `key` (`string`, optional): Key of the topic to filter results. Example: welcome-email
- `limit` (`number`, optional): Limit the number of items to return (max 100) Example: 10
- `name` (`string`, optional): Name of the topic to filter results. Example: Scalekit test
- `orderBy` (`string`, optional): Field to order by. Example: createdAt
- `orderDirection` (`string`, optional): Direction of sorting. Example: ASC. One of: `ASC`, `DESC`.

Example input: `{}`

### `novu_workflow_get`

Retrieve a workflow · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `workflowId` (`string`, required): The workflow ID or its workflow identifier (slug). Example: order-shipped
- `environmentId` (`string`, optional): The environment ID, when reading a workflow from another environment than the key's. Example: 64f1c2b3a4b5c6d7e8f90a1b

Example input: `{"workflowId":"<workflowId>"}`

### `novu_workflow_step_get`

Retrieve workflow step · Read-only

Retrieve data for a specific step in a workflow
Returns an object with data.
Needs workflowId from novu_workflows_list.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `stepId` (`string`, required): The step ID or step identifier inside the workflow. Example: email-step
- `workflowId` (`string`, required): The workflow ID or its workflow identifier (slug). Example: order-shipped

Example input: `{"stepId":"<stepId>","workflowId":"<workflowId>"}`

### `novu_workflows_list`

List all workflows · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `limit` (`number`, optional): Number of items to return per page. Example: 10
- `offset` (`number`, optional): Number of items to skip before starting to return results. Example: 0
- `orderBy` (`string`, optional): Field to sort the results by. Example: createdAt. One of: `createdAt`, `updatedAt`, `name`, `lastTriggeredAt`.
- `orderDirection` (`string`, optional): Direction of sorting. Example: ASC. One of: `ASC`, `DESC`.
- `query` (`string`, optional): Search query to filter workflows. Example: jane
- `status` (`array`, optional): Filter workflows by status. Example: ["ACTIVE"]
- `tags` (`array`, optional): Filter workflows by tags. Example: ["orders"]

Example input: `{}`

### `novu_event_broadcast`

Broadcast Event to All Subscribers · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `name` (`string`, required): The trigger identifier associated for the template you wish to send. This identifier can be found on the template page. Example: Scalekit test
- `payload` (`object`, required): 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"}}
- `actor` (`object`, optional): 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
- `agentId` (`string`, optional): 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
- `context` (`object`, optional): Optional context (key-value pairs such as tenant or workspace identifiers) that scopes the workflow run and Inbox items. Example: {"tenant": "acme"}
- `overrides` (`object`, optional): This could be used to override provider specific configurations. Example: {"fcm": {"data": {"key": "value"}}}
- `tenant` (`object`, optional): 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
- `transactionId` (`string`, optional): A unique identifier for this transaction, we will generated a UUID if not provided. Example: 64f1c2b3a4b5c6d7e8f90a1b

Example input: `{"name":"<name>","payload":{}}`

### `novu_event_trigger`

Trigger Event · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `name` (`string`, required): The trigger identifier of the workflow you wish to send. This identifier can be found on the workflow page. Example: workflow_identifier
- `to` (`array`, required): The recipients list of people who will receive the notification. Maximum number of recipients can be 100. Example: SUBSCRIBER_ID
- `actor` (`object`, optional): 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
- `agentId` (`string`, optional): 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
- `bridgeUrl` (`string`, optional): 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
- `context` (`object`, optional): Optional context (key-value pairs such as tenant or workspace identifiers) that scopes the workflow run and Inbox items. Example: {"tenant": "acme"}
- `overrides` (`object`, optional): This could be used to override provider specific configurations. Example: {"fcm": {"data": {"key": "value"}}}
- `payload` (`object`, optional): 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"}}
- `tenant` (`object`, optional): It is used to specify a tenant context during trigger event. Existing tenants will be updated with the provided details. Example: acme
- `transactionId` (`string`, optional): 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

Example input: `{"name":"<name>","to":[]}`

### `novu_events_bulk_trigger`

Bulk Trigger Events · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `events` (`array`, required): 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"}}]

Example input: `{"events":[{"name":"order-shipped","to":"user-123","payload":{"orderId":"A-1001"}}]}`

### `novu_subscriber_create`

Create a subscriber · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `subscriberId` (`string`, required): Unique identifier of the subscriber. Example: 64f1c2b3a4b5c6d7e8f90a1b
- `avatar` (`string`, optional): Avatar URL or identifier. Example: https://example.com/avatar.jpg
- `data` (`object`, optional): Additional custom data associated with the subscriber. Example: {"company": "Acme", "plan": "enterprise"}
- `email` (`string`, optional): Email address of the subscriber. Example: john.doe@example.com
- `failIfExists` (`boolean`, optional): If true, the request will fail if a subscriber with the same subscriberId already exists. Example: false
- `firstName` (`string`, optional): First name of the subscriber. Example: John
- `lastName` (`string`, optional): Last name of the subscriber. Example: Doe
- `locale` (`string`, optional): Locale of the subscriber. Example: en-US
- `phone` (`string`, optional): Phone number of the subscriber. Example: +1234567890
- `timezone` (`string`, optional): Timezone of the subscriber. Example: America/New_York

Example input: `{"subscriberId":"<subscriberId>"}`

### `novu_subscriber_credentials_upsert`

Upsert Subscriber Provider Credentials · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `credentials` (`object`, required): Credentials payload for the specified provider. Example: {"webhookUrl": "https://example.com/webhook", "channel": "general"}
- `providerId` (`string`, required): The provider identifier for the credentials. Example: slack. One of: `slack`, `discord`, `google-chat`, `msteams`, `webex-messaging`, `mattermost`, `ryver`, `zulip`, `grafana-on-call`, `getstream`, `rocket-chat`, `whatsapp-business`, `line`, `chat-webhook`, `novu-slack`, `telegram`, `sendblue`, `photon-imessage`, `novu-web-chat`, `fcm`, `apns`, `expo`, `one-signal`, `pushpad`, `push-webhook`, `pusher-beams`, `appio`.
- `subscriberId` (`string`, required): The subscriber ID you assigned in your system. Example: user-123
- `integrationIdentifier` (`string`, optional): The integration identifier. Example: slack-workspace

Example input: `{"credentials":{"webhookUrl":"https://example.com/webhook","channel":"general"},"providerId":"slack","subscriberId":"<subscriberId>"}`

### `novu_subscriber_notification_archive`

Archive Inbox Notification · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `notificationId` (`string`, required): The identifier of the notification. Example: 64f1c2b3a4b5c6d7e8f90a1b
- `subscriberId` (`string`, required): The identifier of the subscriber. Example: 64f1c2b3a4b5c6d7e8f90a1b
- `contextKeys` (`array`, optional): Context keys for filtering. Example: ["tenant:acme"]

Example input: `{"notificationId":"<notificationId>","subscriberId":"<subscriberId>"}`

### `novu_subscriber_notification_mark_read`

Mark Inbox Notification Read · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `notificationId` (`string`, required): The identifier of the notification. Example: 64f1c2b3a4b5c6d7e8f90a1b
- `subscriberId` (`string`, required): The identifier of the subscriber. Example: 64f1c2b3a4b5c6d7e8f90a1b
- `contextKeys` (`array`, optional): Context keys for filtering. Example: ["tenant:acme"]

Example input: `{"notificationId":"<notificationId>","subscriberId":"<subscriberId>"}`

### `novu_subscriber_notification_mark_unread`

Mark Inbox Notification Unread · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `notificationId` (`string`, required): The identifier of the notification. Example: 64f1c2b3a4b5c6d7e8f90a1b
- `subscriberId` (`string`, required): The identifier of the subscriber. Example: 64f1c2b3a4b5c6d7e8f90a1b
- `contextKeys` (`array`, optional): Context keys for filtering. Example: ["tenant:acme"]

Example input: `{"notificationId":"<notificationId>","subscriberId":"<subscriberId>"}`

### `novu_subscriber_notification_unarchive`

Unarchive Inbox Notification · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `notificationId` (`string`, required): The identifier of the notification. Example: 64f1c2b3a4b5c6d7e8f90a1b
- `subscriberId` (`string`, required): The identifier of the subscriber. Example: 64f1c2b3a4b5c6d7e8f90a1b
- `contextKeys` (`array`, optional): Context keys for filtering. Example: ["tenant:acme"]

Example input: `{"notificationId":"<notificationId>","subscriberId":"<subscriberId>"}`

### `novu_subscriber_notifications_mark_all_read`

Mark All Inbox Notifications Read · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `subscriberId` (`string`, required): The identifier of the subscriber. Example: 64f1c2b3a4b5c6d7e8f90a1b
- `contextKeys` (`array`, optional): Context keys for filtering notifications. Example: ["tenant:acme"]
- `data` (`string`, optional): Filter notifications by data attributes (JSON string) Example: {"orderId": "A-1001"}
- `tags` (`array`, optional): 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"]

Example input: `{"subscriberId":"<subscriberId>"}`

### `novu_subscriber_notifications_mark_seen`

Mark Inbox Notifications Seen · Write

Mark specific and multiple in-app (inbox) notifications as seen.
Returns an empty response on success (HTTP 204).
Needs subscriberId from novu_subscribers_search.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `subscriberId` (`string`, required): The identifier of the subscriber. Example: 64f1c2b3a4b5c6d7e8f90a1b
- `contextKeys` (`array`, optional): Context keys for filtering notifications. Example: ["tenant:acme"]
- `data` (`string`, optional): Filter notifications by data attributes (JSON string) Example: {"orderId": "A-1001"}
- `notificationIds` (`array`, optional): Specific notification IDs to mark as seen. Example: ["64f1c2b3a4b5c6d7e8f90a1b"]
- `tags` (`array`, optional): 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"]

Example input: `{"subscriberId":"<subscriberId>"}`

### `novu_subscriber_preferences_update`

Update subscriber preferences · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `subscriberId` (`string`, required): The identifier of the subscriber. Example: 64f1c2b3a4b5c6d7e8f90a1b
- `channels` (`object`, optional): Channel-specific preference settings. Example: {"email": false, "sms": false}
- `context` (`object`, optional): Optional context (key-value pairs such as tenant or workspace identifiers) that scopes the workflow run and Inbox items. Example: {"tenant": "acme"}
- `schedule` (`object`, optional): Subscriber schedule. Example: {"isEnabled": true}
- `workflowId` (`string`, optional): Workflow internal _id, identifier or slug. If provided, update workflow specific preferences, otherwise update global preferences. Example: order-shipped

Example input: `{"subscriberId":"<subscriberId>"}`

### `novu_subscriber_update`

Update a subscriber · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `subscriberId` (`string`, required): The identifier of the subscriber. Example: 64f1c2b3a4b5c6d7e8f90a1b
- `avatar` (`string`, optional): Avatar URL or identifier. Example: https://example.com/avatar.jpg
- `data` (`object`, optional): Additional custom data associated with the subscriber. Example: {"company": "Acme", "plan": "enterprise"}
- `email` (`string`, optional): Email address of the subscriber. Example: john.doe@example.com
- `firstName` (`string`, optional): First name of the subscriber. Example: John
- `lastName` (`string`, optional): Last name of the subscriber. Example: Doe
- `locale` (`string`, optional): Locale of the subscriber. Example: en-US
- `phone` (`string`, optional): Phone number of the subscriber. Example: +1234567890
- `timezone` (`string`, optional): Timezone of the subscriber. Example: America/New_York

Example input: `{"subscriberId":"<subscriberId>"}`

### `novu_subscribers_bulk_create`

Bulk create subscribers · Write

Using this endpoint multiple subscribers can be created at once.
Returns an object with data.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `subscribers` (`array`, required): An array of subscribers to be created in bulk. Example: [{"subscriberId": "64f1c2b3a4b5c6d7e8f90a1b"}]

Example input: `{"subscribers":[{"subscriberId":"64f1c2b3a4b5c6d7e8f90a1b"}]}`

### `novu_topic_subscriptions_create`

Create topic subscriptions · Write

Create topic subscriptions. This api will create subscription for subscriberIds for a topic.
Returns an object with data.
Needs topicKey from novu_topics_list.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `topicKey` (`string`, required): The key identifier of the topic. Example: product-updates
- `context` (`object`, optional): Optional context (key-value pairs such as tenant or workspace identifiers) that scopes the workflow run and Inbox items. Example: {"tenant": "acme"}
- `name` (`string`, optional): The name of the topic. Example: My Topic
- `preferences` (`array`, optional): 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"]}}]
- `subscriberIds` (`array`, optional): List of subscriber IDs to subscribe to the topic (max: 100). @deprecated Use the "subscriptions" property instead. Example: ["subscriberId1", "subscriberId2"]
- `subscriptions` (`array`, optional): 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"}]

Example input: `{"topicKey":"<topicKey>"}`

### `novu_topic_update`

Update a topic · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `topicKey` (`string`, required): The key identifier of the topic. Example: product-updates
- `data` (`object`, optional): 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"}
- `name` (`string`, optional): The display name for the topic. Example: Updated Topic Name

Example input: `{"topicKey":"<topicKey>"}`

### `novu_topic_upsert`

Create or Update Topic · Write

Create a new topic if it does not exist, or updates an existing topic if it already exists.
Returns an object with data.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `key` (`string`, required): 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
- `data` (`object`, optional): 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"}
- `failIfExists` (`boolean`, optional): If true, the request will fail if a topic with the same key already exists. Example: false
- `name` (`string`, optional): The display name for the topic. Example: Task Title

Example input: `{"key":"<key>"}`

### `novu_workflow_create`

Create a workflow · Write

Create a new workflow in the Novu Cloud environment
Returns an object with data.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `name` (`string`, required): Name of the workflow. Example: Scalekit test
- `steps` (`array`, required): Steps of the workflow. Example: [{"name": "Scalekit test", "type": "in_app"}]
- `workflowId` (`string`, required): Unique identifier for the workflow. Example: order-shipped
- `__source` (`string`, optional): Source of workflow creation. Example: editor. One of: `template_store`, `editor`, `notification_directory`, `onboarding_digest_demo`, `onboarding_in_app`, `empty_state`, `dropdown`, `onboarding_get_started`, `bridge`, `dashboard`, `ai`.
- `active` (`boolean`, optional): Whether the workflow is active. Example: false
- `description` (`string`, optional): Description of the workflow. Example: Created by the Scalekit connector
- `isTranslationEnabled` (`boolean`, optional): Enable or disable translations for this workflow. Example: false
- `payloadSchema` (`object`, optional): The payload JSON Schema for the workflow. Example: {"type": "object", "properties": {"orderId": {"type": "string"}}}
- `preferences` (`object`, optional): 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}}}}
- `severity` (`string`, optional): Severity of the workflow. Example: high. One of: `high`, `medium`, `low`, `none`.
- `tags` (`array`, optional): Tags associated with the workflow. Example: ["orders"]
- `validatePayload` (`boolean`, optional): Enable or disable payload schema validation. Example: false

Example input: `{"name":"<name>","steps":[{"name":"Scalekit test","type":"in_app"}],"workflowId":"<workflowId>"}`

### `novu_workflow_patch`

Patch Workflow · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `workflowId` (`string`, required): The workflow ID or its workflow identifier (slug). Example: order-shipped
- `active` (`boolean`, optional): Activate or deactivate the workflow. Example: false
- `description` (`string`, optional): Updated description of the workflow. Example: Created by the Scalekit connector
- `isTranslationEnabled` (`boolean`, optional): Enable or disable translations for this workflow. Example: false
- `name` (`string`, optional): New name for the workflow. Example: Scalekit test
- `payloadSchema` (`object`, optional): The payload JSON Schema for the workflow. Example: {"type": "object", "properties": {"orderId": {"type": "string"}}}
- `tags` (`array`, optional): Tags associated with the workflow. Example: ["orders"]
- `validatePayload` (`boolean`, optional): Enable or disable payload schema validation. Example: false

Example input: `{"workflowId":"<workflowId>"}`

### `novu_workflow_update`

Update Workflow · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `name` (`string`, required): Name of the workflow. Example: Scalekit test
- `preferences` (`object`, required): 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}}}}
- `steps` (`array`, required): Steps of the workflow. Example: [{"name": "Scalekit test", "type": "in_app"}]
- `workflowId` (`string`, required): The workflow ID or its workflow identifier (slug). Example: order-shipped
- `active` (`boolean`, optional): Whether the workflow is active. Example: false
- `body_workflowId` (`string`, optional): Workflow ID (allowed only for code-first workflows) Example: Hello from Scalekit
- `description` (`string`, optional): Description of the workflow. Example: Created by the Scalekit connector
- `isTranslationEnabled` (`boolean`, optional): Enable or disable translations for this workflow. Example: false
- `origin` (`string`, optional): Origin of the workflow. Accepted for backwards compatibility but ignored on update. Example: novu-cloud. One of: `novu-cloud`, `novu-cloud-v1`, `external`.
- `payloadSchema` (`object`, optional): The payload JSON Schema for the workflow. Example: {"type": "object", "properties": {"orderId": {"type": "string"}}}
- `severity` (`string`, optional): Severity of the workflow. Example: high. One of: `high`, `medium`, `low`, `none`.
- `tags` (`array`, optional): Tags associated with the workflow. Example: ["orders"]
- `validatePayload` (`boolean`, optional): Enable or disable payload schema validation. Example: false

Example input: `{"name":"<name>","preferences":{},"steps":[{"name":"Scalekit test","type":"in_app"}],"workflowId":"<workflowId>"}`

### `novu_event_cancel`

Cancel Triggered Event · Destructive

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.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `transactionId` (`string`, required): The transaction ID returned when the event was triggered. Example: 3c7f1a2b-9d4e-4f5a-8b6c-7d8e9f0a1b2c

Example input: `{"transactionId":"<transactionId>"}`

### `novu_message_delete`

Delete a message · Destructive

Delete a message entity from the Novu platform by messageId.
Returns an object with data.
Needs messageId from novu_messages_list.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `messageId` (`string`, required): The message ID. Example: 64f1c2b3a4b5c6d7e8f90a1b

Example input: `{"messageId":"<messageId>"}`

### `novu_messages_delete_by_transaction`

Delete Messages by Transaction · Destructive

Delete multiple messages from the Novu platform using transactionId of triggered event.
Returns an empty response on success (HTTP 204).

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `transactionId` (`string`, required): The transaction ID returned when the event was triggered. Example: 3c7f1a2b-9d4e-4f5a-8b6c-7d8e9f0a1b2c
- `channel` (`string`, optional): The channel of the message to be deleted. Example: in_app. One of: `in_app`, `email`, `sms`, `chat`, `push`, `tool`.

Example input: `{"transactionId":"<transactionId>"}`

### `novu_subscriber_credentials_delete`

Delete Subscriber Provider Credentials · Destructive

Delete subscriber credentials for a provider such as slack and FCM by providerId.
Returns an empty response on success (HTTP 204).

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `providerId` (`string`, required): The chat or push provider whose credentials to delete, such as slack, discord, fcm or apns. Example: slack
- `subscriberId` (`string`, required): The subscriber ID you assigned in your system. Example: user-123

Example input: `{"providerId":"<providerId>","subscriberId":"<subscriberId>"}`

### `novu_subscriber_delete`

Delete a subscriber · Destructive

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.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `subscriberId` (`string`, required): The identifier of the subscriber. Example: 64f1c2b3a4b5c6d7e8f90a1b

Example input: `{"subscriberId":"<subscriberId>"}`

### `novu_subscriber_notification_delete`

Delete Inbox Notification · Destructive

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.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `notificationId` (`string`, required): The identifier of the notification. Example: 64f1c2b3a4b5c6d7e8f90a1b
- `subscriberId` (`string`, required): The identifier of the subscriber. Example: 64f1c2b3a4b5c6d7e8f90a1b
- `contextKeys` (`array`, optional): Context keys for filtering. Example: ["tenant:acme"]

Example input: `{"notificationId":"<notificationId>","subscriberId":"<subscriberId>"}`

### `novu_topic_delete`

Delete a topic · Destructive

Delete a topic by its unique key identifier topicKey.
Returns an object with data.
Needs topicKey from novu_topics_list.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `topicKey` (`string`, required): The key identifier of the topic. Example: product-updates

Example input: `{"topicKey":"<topicKey>"}`

### `novu_topic_subscriptions_delete`

Delete topic subscriptions · Destructive

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.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `topicKey` (`string`, required): The key identifier of the topic. Example: product-updates
- `subscriberIds` (`array`, optional): List of subscriber identifiers to unsubscribe from the topic (max: 100). @deprecated Use the "subscriptions" property instead. Example: ["subscriberId1", "subscriberId2"]
- `subscriptions` (`array`, optional): 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"}]

Example input: `{"topicKey":"<topicKey>"}`

### `novu_workflow_delete`

Delete a workflow · Destructive

Remove a specific workflow by its unique identifier workflowId
Returns an empty response on success (HTTP 204).
Needs workflowId from novu_workflows_list.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `workflowId` (`string`, required): The workflow ID or its workflow identifier (slug). Example: order-shipped

Example input: `{"workflowId":"<workflowId>"}`

## Related

Other Communication connectors ([all 132](/agentkit/connectors/?category=communication)):

- [Gmail](/agentkit/connectors/gmail/): Scalekit connector, OAuth, 48 tools
- [Slack](/agentkit/connectors/slack/): Scalekit connector, OAuth, 96 tools
- [Google Calendar](/agentkit/connectors/googlecalendar/): Scalekit connector, OAuth, 30 tools


---

## More Scalekit documentation

| Resource | What it contains | When to use it |
|----------|-----------------|----------------|
| [/llms.txt](/llms.txt) | Structured index with routing hints per product area | Start here — find which documentation set covers your topic before loading full content |
| [/llms-full.txt](/llms-full.txt) | Complete documentation for all Scalekit products in one file | Use when you need exhaustive context across multiple products or when the topic spans several areas |
| [sitemap-0.xml](https://docs.scalekit.com/sitemap-0.xml) | Full URL list of every documentation page | Use to discover specific page URLs you can fetch for targeted, page-level answers |
