> For the complete documentation index, see [llms.txt](https://docs.stackai.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.stackai.com/integrations/catalog/novu.md).

# Novu

Trigger notification workflows and manage subscribers, preferences, and topics.

### Connectors

Choose the connector that matches your authentication method. The options below use the names shown in StackAI.

| Connector | Authentication |
| --------- | -------------- |
| Novu      | Secret Key     |

#### Novu

Connect an environment to trigger workflows and manage subscribers and topics.

**Set up in Novu**

1. Prepare the Novu account or service that the workflow will access. Grant access to the required resources and operations.
2. **Secret Key:** Copy the environment-specific Secret Key from Developer > API Keys in Novu. Do not use the public Application Identifier.

**Set up in StackAI**

1. Open **Settings → Connections**, add a connection, and select **Novu**.
2. Enter the credentials and connection details in the fields below.
3. Save the connection and check its connection status. Select this saved connection when configuring an action or feature that uses it.

**Connection fields**

| StackAI field | Required                 | What to enter                                                                                                                                                                                   |
| ------------- | ------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Secret Key    | Yes                      | Copy the environment-specific Secret Key from Developer > API Keys in Novu. Do not use the public Application Identifier. [Provider instructions](https://dashboard.novu.co/settings/api-keys). |
| Data Region   | Optional / as applicable | Choose the US or EU region that contains the Novu environment for this key. [Provider instructions](https://docs.novu.co/platform/developer/api-keys).                                          |

#### Verify the connection

Check that the connection is healthy. Then run a read operation against a resource the connected account can access. A successful connection check confirms authentication; it does not guarantee permission for every action.

If access is denied, check the credential or OAuth permissions, the selected account or environment, and access to the specific resource. Update expired credentials or reconnect after permissions change.

### Use an action

1. Add the required **Novu** action to the workflow.
2. Select a connection when the action requests one.
3. Complete the required fields. Use the reference picker when a value comes from another workflow step.
4. Run the workflow and inspect the action’s output. Check the result before using it in a later step.

### Actions

#### Trigger Notification Event

Trigger a published Novu workflow for one subscriber.

**Inputs**

| Field            | Type            | Required | Description                                                                                         |
| ---------------- | --------------- | -------- | --------------------------------------------------------------------------------------------------- |
| Workflow         | select (string) | Yes      | Published workflow to trigger. Options load from the selected connection.                           |
| Subscriber       | select (string) | Yes      | Existing subscriber who should receive the notification. Options load from the selected connection. |
| Workflow Payload | object          | No       | Values used by the workflow templates and rules.                                                    |
| Transaction ID   | string          | No       | Stable ID used to prevent duplicate triggers.                                                       |

**Outputs**

| Field              | Type    | Description                           |
| ------------------ | ------- | ------------------------------------- |
| Acknowledged       | boolean | Whether Novu accepted the trigger.    |
| Status             | string  | Novu trigger status.                  |
| Transaction ID     | string  | Transaction ID used for this trigger. |
| Activity Feed Link | string  | Novu activity link when returned.     |

#### Create Subscriber

Create a Novu subscriber or update one with the same ID.

**Inputs**

| Field         | Type   | Required | Description                           |
| ------------- | ------ | -------- | ------------------------------------- |
| Subscriber ID | string | Yes      | Stable user ID from your application. |
| Email         | string | No       | Email delivery address.               |
| First Name    | string | No       | Optional first name.                  |
| Last Name     | string | No       | Optional last name.                   |
| Phone         | string | No       | Optional phone number.                |
| Locale        | string | No       | Optional language and region.         |
| Timezone      | string | No       | Optional IANA timezone.               |
| Custom Data   | object | No       | Custom subscriber values as JSON.     |

**Outputs**

| Field      | Type   | Description                            |
| ---------- | ------ | -------------------------------------- |
| Subscriber | object | Subscriber created or updated by Novu. |

#### Update Subscriber Preferences

Update global or workflow-specific channel preferences for a subscriber.

**Inputs**

| Field      | Type            | Required | Description                                                                                                           |
| ---------- | --------------- | -------- | --------------------------------------------------------------------------------------------------------------------- |
| Subscriber | select (string) | Yes      | Subscriber whose notification preferences should change. Options load from the selected connection.                   |
| Workflow   | select (string) | No       | Optional workflow-specific preference. Leave blank for global preferences. Options load from the selected connection. |
| Email      | boolean         | No       | Enable or disable email notifications.                                                                                |
| SMS        | boolean         | No       | Enable or disable SMS notifications.                                                                                  |
| In-App     | boolean         | No       | Enable or disable in-app notifications.                                                                               |
| Chat       | boolean         | No       | Enable or disable chat notifications.                                                                                 |
| Push       | boolean         | No       | Enable or disable push notifications.                                                                                 |

**Outputs**

| Field       | Type   | Description                           |
| ----------- | ------ | ------------------------------------- |
| Preferences | object | Current preferences returned by Novu. |

#### Create Topic

Create a Novu topic or update the topic with the same key.

**Inputs**

| Field     | Type   | Required | Description                      |
| --------- | ------ | -------- | -------------------------------- |
| Topic Key | string | Yes      | Stable unique key for the topic. |
| Name      | string | No       | Optional display name.           |

**Outputs**

| Field | Type   | Description                       |
| ----- | ------ | --------------------------------- |
| Topic | object | Topic created or updated by Novu. |

#### Add Subscribers to Topic

Add up to 100 existing subscribers to a Novu topic.

**Inputs**

| Field          | Type            | Required | Description                                                                           |
| -------------- | --------------- | -------- | ------------------------------------------------------------------------------------- |
| Topic          | select (string) | Yes      | Topic that should receive the subscribers. Options load from the selected connection. |
| Subscriber IDs | textarea        | Yes      | Up to 100 subscriber IDs separated by commas or new lines.                            |

**Outputs**

| Field     | Type    | Description                                  |
| --------- | ------- | -------------------------------------------- |
| Requested | integer | Unique subscribers submitted.                |
| Added     | integer | Subscriptions Novu created successfully.     |
| Failed    | integer | Subscriptions Novu could not create.         |
| Errors    | array   | Per-subscriber failures without secret data. |

### Important behavior

Actions that create, update, send, or delete data can change the connected service. Review their inputs before running them. A retry can repeat an operation; consider this when configuring retries for actions that change data.

The catalog lists the fields and capabilities available in the supplied provider definition. Availability can also depend on your deployment and organization’s Feature Access settings.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.stackai.com/integrations/catalog/novu.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
