Novu

https://docs.novu.co/
Admin
Novu is a notification platform that enables developers to send notifications to subscribers across...
Tokens:1,167,441
Snippets:7,117
Trust Score:10
Update:1 week ago
Show doc for...
Tokens:
Raw
### Install dependencies with setup:project

Source: https://docs.novu.co/community/run-in-local-machine

Install all dependencies with pnpm, create default .env files from .example.env, and build the monorepo.

```bash
npm run setup:project

```

--------------------------------

### Create Environment - Go SDK Example

Source: https://docs.novu.co/api-reference/environments/create-an-environment

Use this Go code to create an environment with the Novu Go SDK. It imports the required context, novu-go v3, and components packages, then initializes a client in the main function. The example shows the minimal setup needed to start working with the SDK.

```go
package main

import(
	"context"
	"github.com/novuhq/novu-go/v3"
	"github.com/novuhq/novu-go/v3/models/components"
	"log"
)

func main() {
    ctx := context.Background()

    s := novu.New(
        novu.WithSecurity(
            components.Security{
                SecretKey: components.CreateSecuritySecretKey(
```

```go
package main

import(
	"context"
	"github.com/novuhq/novu-go/v3"
	"github.com/novuhq/novu-go/v3/models/components"
	"log"
)

func main() {
    ctx := context.Background()

    s := novu.New(
        novu.WithSecurity(
            components.Security{
                SecretKey: components.CreateSecuritySecretKey(
```

```go
package main

import(
	"context"
	"github.com/novuhq/novu-go/v3"
	"github.com/novuhq/novu-go/v3/models/components"
	"log"
)

func main() {
    ctx := context.Background()

    s := novu.New(
        components.Security{
            SecretKey: components.CreateSecuritySecretKey(
                
```

--------------------------------

### Install Novu Go SDK

Source: https://docs.novu.co/platform/sdks/server/go

Install the Novu Go SDK using the go get command.

```bash
go get github.com/novuhq/novu-go

```

--------------------------------

### Run local environment setup script

Source: https://docs.novu.co/community/run-in-local-machine

Run the local environment setup script (beta) directly. It tries to install OS dependencies needed to run Novu locally before `npm run setup:project`. You still need git and Node.js installed beforehand. On supported platforms it can detect macOS or GNU/Linux, install or update common OS dependencies (macOS only for some steps), install NVM, Node.js v22.23.0, pnpm, and Docker, and install MongoDB and Redis (macOS via Homebrew). It may optionally clone the Novu repository. This script has been tested most thoroughly on macOS; Linux support is limited. It is not bullet-proof and some tasks have intertwined dependencies; report problems on GitHub but idempotency is not guaranteed on every system.

```bash
npm run dev-environment-setup

```

--------------------------------

### Run Novu setup script

Source: https://docs.novu.co/community/self-hosting-novu/deploy-with-docker

Downloads the setup script, generates secure secrets, and starts Novu services. Requires Docker, docker-compose, curl, and openssl.

```bash
curl -fsSL https://raw.githubusercontent.com/novuhq/novu/next/docker/community/setup.sh | bash

```

--------------------------------

### Quick Start with OpenAI

Source: https://docs.novu.co/platform/build-with-ai/agent-toolkit

Quick Start example for the OpenAI framework. Creates a Novu agent toolkit with a secret key and subscriber ID, passes its tools to an OpenAI chat completion, and handles any tool calls returned by the model. Requires the openai peer dependency and a NOVU_SECRET_KEY environment variable.

```typescript
import { createNovuAgentToolkit } from '@novu/agent-toolkit/openai';
import OpenAI from 'openai';

const openai = new OpenAI();

const toolkit = await createNovuAgentToolkit({
  secretKey: process.env.NOVU_SECRET_KEY,
  subscriberId: 'user-123',
});

const response = await openai.chat.completions.create({
  model: 'gpt-4o',
  messages: [{ role: 'user', content: 'Send a welcome email to user-123' }],
  tools: toolkit.tools,
});

for (const toolCall of response.choices[0].message.tool_calls ?? []) {
  const result = await toolkit.handleToolCall(toolCall);
  console.log(result);
}

```

--------------------------------

### Install Novu skills with npx

Source: https://docs.novu.co/platform/build-with-ai/skills

Install Novu skills in Cursor before using the example prompts. Replace YOUR_* placeholders with values from the Novu dashboard.

```bash
npx skills add novuhq/skills
```

--------------------------------

### Initialize and run Novu bridge application

Source: https://docs.novu.co/community/self-hosting-novu/deploy-with-docker

Set up a bridge application using @novu/framework. Initializes the project, installs dependencies, and starts the dev server on port 4005 to avoid conflict with the Dashboard on port 4000. Verify the bridge endpoint at http://localhost:4005/api/novu.

```bash
# Initialize the bridge application
npx novu@latest init \
  --secret-key=<secret_key> \
  --api-url=http://localhost:3000

# Install dependencies
npm install

# Start the bridge application on a port that does not conflict with the Dashboard (4000)
npm run dev -- --port 4005

```

--------------------------------

### Trigger workflow to multiple topics in Node.js, Python, Go, PHP, .NET, Java, and cURL

Source: https://docs.novu.co/platform/workflow/trigger-workflow

Trigger a workflow to multiple topics by passing an array of topic recipients to the `to` field. Novu automatically de-duplicates subscribers who belong to more than one topic, so each subscriber receives the notification only once. Each language example uses the same workflow identifier and two topic keys.

```javascript
import { Novu } from "@novu/api"

const novu = new Novu({ secretKey: "<YOUR_SECRET_KEY_HERE>", });

await novu.trigger({
  workflowId: "workflow_identifier",
  to: [
    { type: "Topic", topicKey: "topic_key_1" }, 
    { type: "Topic", topicKey: "topic_key_2" }
  ]
});

```

```python
import os
import novu_py
from novu_py import Novu

with Novu(secret_key=os.getenv("NOVU_SECRET_KEY", "")) as novu:
    novu.trigger(trigger_event_request_dto=novu_py.TriggerEventRequestDto(
        workflow_id="workflow_identifier",
        to=[
            {"type": "Topic", "topic_key": "topic_key_1"},
            {"type": "Topic", "topic_key": "topic_key_2"},
        ],
    ))

```

```go
import (
    "context"
    "os"

    novugo "github.com/novuhq/novu-go"
    "github.com/novuhq/novu-go/models/components"
)

s := novugo.New(novugo.WithSecurity(os.Getenv("NOVU_SECRET_KEY")))

res, err := s.Trigger(context.Background(), components.TriggerEventRequestDto{
    WorkflowID: "workflow_identifier",
    To: components.CreateToArrayOfTo1([]components.To1{
        components.CreateTo1TopicPayloadDto(components.TopicPayloadDto{
            Type:     components.TriggerRecipientsTypeEnumTopic,
            TopicKey: "topic_key_1",
        }),
        components.CreateTo1TopicPayloadDto(components.TopicPayloadDto{
            Type:     components.TriggerRecipientsTypeEnumTopic,
            TopicKey: "topic_key_2",
        }),
    }),
}, nil)

```

```php
use novu;
use novu\Models\Components;

$sdk = novu\Novu::builder()
    ->setSecurity('<YOUR_SECRET_KEY_HERE>')
    ->build();

$sdk->trigger(
    triggerEventRequestDto: new Components\TriggerEventRequestDto(
        workflowId: 'workflow_identifier',
        to: [
            new Components\TopicPayloadDto(
                topicKey: 'topic_key_1',
                type: Components\TriggerRecipientsTypeEnum::Topic,
            ),
            new Components\TopicPayloadDto(
                topicKey: 'topic_key_2',
                type: Components\TriggerRecipientsTypeEnum::Topic,
            ),
        ],
    ),
);

```

```csharp
using Novu;
using Novu.Models.Components;
using System.Collections.Generic;

var sdk = new NovuSDK(secretKey: "<YOUR_SECRET_KEY_HERE>");

await sdk.TriggerAsync(triggerEventRequestDto: new TriggerEventRequestDto() {
    WorkflowId = "workflow_identifier",
    To = To.CreateArrayOfTo1(new List<To1> {
        To1.CreateTopicPayloadDto(new TopicPayloadDto() {
            Type = TriggerRecipientsTypeEnum.Topic,
            TopicKey = "topic_key_1",
        }),
        To1.CreateTopicPayloadDto(new TopicPayloadDto() {
            Type = TriggerRecipientsTypeEnum.Topic,
            TopicKey = "topic_key_2",
        }),
    }),
});

```

```java
import co.novu.Novu;
import co.novu.models.components.*;
import java.util.List;

Novu novu = Novu.builder()
    .secretKey("<YOUR_SECRET_KEY_HERE>")
    .build();

novu.trigger()
    .body(TriggerEventRequestDto.builder()
        .workflowId("workflow_identifier")
        .to(To2.of(List.of(
            To1.of(TopicPayloadDto.builder()
                .type(TriggerRecipientsTypeEnum.TOPIC)
                .topicKey("topic_key_1")
                .build()),
            To1.of(TopicPayloadDto.builder()
                .type(TriggerRecipientsTypeEnum.TOPIC)
                .topicKey("topic_key_2")
                .build()))))
        .build())
    .call();

```

```bash
curl -X POST 'https://api.novu.co/v1/events/trigger' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: ApiKey <NOVU_SECRET_KEY>' \
-d '{
    "name": "workflow_identifier",
    "to": [
      {
          "type": "Topic",
          "topicKey": "topic_key_1"
      },
      {
          "type": "Topic",
          "topicKey": "topic_key_2"
      }
    ]
}'

```

--------------------------------

### Connect Telegram agent using CLI

Source: https://docs.novu.co/platform/integrations/chat/telegram

Run this command in your terminal to start the interactive CLI setup for connecting an agent to Telegram. You will be prompted to select your agent and Telegram, then guided through bot setup, token entry, and a test message.

```bash
npx novu@latest connect

```

--------------------------------

### Run initial setup command

Source: https://docs.novu.co/community/add-a-new-provider

Run the initial setup command to set up the repository. Requires pnpm (or npm) and Node.js v20.8.1.

```bash
pnpm run setup:project

```

--------------------------------

### Install @novu/framework, ai, and a provider package

Source: https://docs.novu.co/agents/custom-code-agent/frameworks/ai-sdk

Install the required packages for the AI SDK adapter. @novu/framework and ai are required; pick one provider package (OpenAI, Anthropic, Google, or Groq).

```bash
npm install @novu/framework ai @ai-sdk/openai

```

```bash
npm install @novu/framework ai @ai-sdk/anthropic

```

```bash
npm install @novu/framework ai @ai-sdk/google

```

```bash
npm install @novu/framework ai @ai-sdk/groq

```

--------------------------------

### GET /v2/topics/{topicKey}/subscriptions

Source: https://docs.novu.co/api-reference/topics/list-topic-subscriptions

This snippet documents the GET endpoint for listing topic subscriptions, including its parameters and example request.

```APIDOC
## GET /v2/topics/{topicKey}/subscriptions

### Description
Retrieves a list of subscriptions for a specific topic identified by its key.

### Method
GET

### Endpoint
`/v2/topics/{topicKey}/subscriptions`

### Parameters
#### Path Parameters
- **topicKey** (string) - Required - The key of the topic for which to list subscriptions.

#### Query Parameters
- **limit** (number) - Optional - The maximum number of subscriptions to return.
- **contextKeys** (array of strings) - Optional - A list of context keys to filter subscriptions by.

### Request Example
```
curl --request GET \
  --url https://api.novu.co/v2/topics/{topicKey}/subscriptions \
  --header 'Authorization: <api-key>'
```

### Response
#### Success Response (200)
Returns a `ListTopicSubscriptionsResponseDto` object containing the list of subscriptions.

#### Response Example
```
{
  // ListTopicSubscriptionsResponseDto
}
```
```

--------------------------------

### GET /v1/agents

Source: https://docs.novu.co/api-reference/agents/list-all-agents

This snippet documents the GET /v1/agents endpoint, including its parameters, request example, response schema, and error responses.

```APIDOC
## GET /v1/agents

### Description
Retrieves a list of all agents in the Novu platform. This endpoint returns an array of agent objects with their configuration details, including behavior, runtime, and integration settings.

### Method
GET

### Endpoint
https://api.novu.co/v1/agents

### Parameters
#### Query Parameters
- **limit** (number) - Optional - The maximum number of agents to return in the response.

### Request Example
```
curl --request GET \
  --url https://api.novu.co/v1/agents \
  --header 'Authorization: <api-key>'
```

### Response
#### Success Response (200)
- **data** (array) - List of agent objects.
  - **_id** (string) - Unique identifier of the agent.
  - **name** (string) - Name of the agent.
  - **identifier** (string) - Unique identifier for the agent.
  - **behavior** (object) - Configuration for agent behavior.
    - **acknowledgeOnReceived** (boolean) - Whether the agent acknowledges on received.
    - **reactionOnResolved** (string) - Reaction on resolved.
    - **subscriberAccess** (string) - Subscriber access level.
  - **active** (boolean) - Whether the agent is active.
  - **_environmentId** (string) - Environment identifier.
  - **_organizationId** (string) - Organization identifier.
  - **createdAt** (string) - Creation timestamp.
  - **updatedAt** (string) - Last update timestamp.
  - **description** (string) - Description of the agent.
  - **bridgeUrl** (string) - Bridge URL.
  - **devBridgeUrl** (string) - Development bridge URL.
  - **devBridgeActive** (boolean) - Whether the development bridge is active.
  - **runtime** (string) - Runtime type (e.g., self-hosted).
  - **visibility** (string) - Visibility (e.g., public).
  - **managedRuntime** (object) - Managed runtime configuration.
    - **providerId** (string) - Provider identifier.
    - **integrationId** (string) - Integration identifier.
    - **externalAgentId** (string) - External agent identifier.
    - **externalEnvironmentId** (string) - External environment identifier.
    - **externalWorkspaceId** (string) - External workspace identifier.
    - **consoleUrl** (string) - Console URL.
    - **tools** (array) - List of tools.
      - **externalId** (string) - External identifier.
      - **name** (string) - Tool name.
      - **type** (string) - Tool type (e.g., builtin).
      - **description** (string) - Tool description.
    - **mcpServers** (array) - List of MCP servers.
      - **externalId** (string) - External identifier.
      - **name** (string) - Server name.
      - **url** (string) - Server URL.
    - **systemPrompt** (string) - System prompt.
  - **createdBy** (string) - Creator identifier.
  - **integrations** (array) - List of integrations.
    - **integrationId** (string) - Integration identifier.
    - **providerId** (string) - Provider identifier.
    - **name** (string) - Integration name.
    - **identifier** (string) - Integration identifier.
    - **active** (boolean) - Whether the integration is active.
    - **channel** (string) - Channel type (e.g., in_app).
  - **exceedsPlanLimit** (boolean) - Whether the agent exceeds plan limit.
- **next** (string) - Next page cursor.
- **previous** (string) - Previous page cursor.
- **totalCount** (number) - Total number of agents.
- **totalCountCapped** (boolean) - Whether the total count is capped.
- **planUsage** (object) - Plan usage details.
  - **used** (number) - Used count.
  - **limit** (number) - Limit.
  - **totalCreated** (number) - Total created.
  - **creationLimit** (number) - Creation limit.
  - **limitSource** (string) - Limit source (e.g., plan).

#### Response Example
```
{
  "data": [
    {
      "_id": "<string>",
      "name": "<string>",
      "identifier": "<string>",
      "behavior": {
        "acknowledgeOnReceived": true,
        "reactionOnResolved": "check",
        "subscriberAccess": "open"
      },
      "active": true,
      "_environmentId": "<string>",
      "_organizationId": "<string>",
      "createdAt": "<string>",
      "updatedAt": "<string>",
      "description": "<string>",
      "bridgeUrl": "<string>",
      "devBridgeUrl": "<string>",
      "devBridgeActive": true,
      "runtime": "self-hosted",
      "visibility": "public",
      "managedRuntime": {
        "providerId": "<string>",
        "integrationId": "<string>",
        "externalAgentId": "<string>",
        "externalEnvironmentId": "<string>",
        "externalWorkspaceId": "<string>",
        "consoleUrl": "<string>",
        "tools": [
          {
            "externalId": "<string>",
            "name": "<string>",
            "type": "builtin",
            "description": "<string>"
          }
        ],
        "mcpServers": [
          {
            "externalId": "<string>",
            "name": "<string>",
            "url": "<string>"
          }
        ],
        "systemPrompt": "<string>"
      },
      "createdBy": "<string>",
      "integrations": [
        {
          "integrationId": "<string>",
          "providerId": "<string>",
          "name": "<string>",
          "identifier": "<string>",
          "active": true,
          "channel": "in_app"
        }
      ],
      "exceedsPlanLimit": true
    }
  ],
  "next": "<string>",
  "previous": "<string>",
  "totalCount": 123,
  "totalCountCapped": true,
  "planUsage": {
    "used": 123,
    "limit": 123,
    "totalCreated": 123,
    "creationLimit": 123,
    "limitSource": "plan"
  }
}
```

### Error Responses
- **400** - Bad Request
- **401** - Unauthorized
- **403** - Forbidden
- **404** - Not Found
- **405** - Method Not Allowed
- **409** - Conflict
- **413** - Payload Too Large
- **414** - URI Too Long
- **415** - Unsupported Media Type
- **422** - Unprocessable Entity
- **429** - Too Many Requests
- **500** - Internal Server Error
- **503** - Service Unavailable

#### Error Response Example
```
{
  "statusCode": 404,
  "timestamp": "2024-12-12T13:00:00Z",
  "path": "/api/v1/resource",
  "message": "xx xx xx ",
  "ctx": {
    "workflowId": "some_wf_id",
    "stepId": "some_wf_id"
  },
  "errorId": "abc123"
}
```
```

--------------------------------

### Go SDK Example

Source: https://docs.novu.co/api-reference/subscribers/search-subscribers

Example of using the Novu Go SDK to search subscribers.

```go
```go
package main

import(
	"context"
	"github.com/novuhq/novu-go/v3"
	"github.com/novuhq/novu-go/v3/models/operations"
	"log"
)

func main() {
    ctx := context.Background()

    s := v3.New(
        v3.WithSecurity("YOUR_SECRET_KEY_HERE"),
    )

    res, err := s.Subscribers.Search(ctx, operations.SubscribersControllerSearchSubscribersRequest{
        Limit: v3.Pointer[float64](10.0),
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.ListSubscribersResponseDto != nil {
        // handle response
    }
}
```
```

--------------------------------

### Example request with curl

Source: https://docs.novu.co/api-reference/authentication

Example GET request to the Novu API subscribers endpoint using the Authorization header with the secret key.

```bash
curl -X GET https://api.novu.co/v1/subscribers \
  --header 'Authorization: ApiKey <NOVU_SECRET_KEY>'

```

--------------------------------

### GET /v2/subscribers/{subscriberId}/preferences

Source: https://docs.novu.co/api-reference/subscribers/retrieve-subscriber-preferences

This snippet documents the GET endpoint for retrieving subscriber preferences, including parameters, request example, and response structure.

```APIDOC
## GET /v2/subscribers/{subscriberId}/preferences

### Description
Retrieves the preferences of a subscriber, including global and workflow-specific settings. This endpoint allows filtering by criticality and context keys.

### Method
GET

### Endpoint
`https://api.novu.co/v2/subscribers/{subscriberId}/preferences`

### Parameters
#### Path Parameters
- **subscriberId** (string) - Required - The identifier of the subscriber

#### Query Parameters
- **criticality** (enum<string>) - Optional - Default: `nonCritical` - Available options: `critical`, `nonCritical`, `all`
- **contextKeys** (string[]) - Optional - Context keys for filtering preferences (e.g., `["tenant:acme"]`)

#### Headers
- **Authorization** (string) - Required - API key authentication. Allowed header: `Authorization: ApiKey <novu_secret_key>`
- **idempotency-key** (string) - Optional - A header for idempotency purposes

### Request Example
```
curl --request GET \
  --url 'https://api.novu.co/v2/subscribers/{subscriberId}/preferences?criticality=nonCritical' \
  --header 'Authorization: <api-key>'
```

### Response
#### Success Response (200)
- **global** (object) - Required - Global preference settings
- **workflows** (object[]) - Required - Workflow-specific preference settings

#### Response Example
```json
{
  "global": {},
  "workflows": []
}
```

### Error Responses
- **404** - Not Found - Returns an error object with `statusCode`, `timestamp`, `path`, `message`, `ctx`, and `errorId`.
- **429** - Too Many Requests - Returns the message "API rate limit exceeded" and suggests waiting before retrying.

```

--------------------------------

### Basic setup with OpenAI adapter

Source: https://docs.novu.co/platform/build-with-ai/agent-toolkit

Creates a Novu agent toolkit using the OpenAI adapter. Returns native OpenAI function tool definitions and a handler to execute tool calls.

```typescript
import { createNovuAgentToolkit } from '@novu/agent-toolkit/openai';

const toolkit = await createNovuAgentToolkit({
  secretKey: process.env.NOVU_SECRET_KEY,
  subscriberId: 'user-123',
});

// toolkit.tools - OpenAI function tool definitions
// toolkit.handleToolCall - execute a tool call and return a result

```

--------------------------------

### Install @novu/framework as dev dependency

Source: https://docs.novu.co/platform/workflow/add-and-configure-steps/code-steps

Install @novu/framework as a dev dependency to get full TypeScript types for controls, payload, subscriber, context, and steps.

```bash
npm install --save-dev @novu/framework
```

--------------------------------

### List contexts with SDKs (Go, TypeScript, C#, PHP, Python)

Source: https://docs.novu.co/api-reference/contexts/list-all-contexts

SDK examples for listing contexts using limit, id, and search filters. Each example requires a secret key and handles the response.

```Go
package main

import(
	"context"
	"github.com/novuhq/novu-go/v3"
	"github.com/novuhq/novu-go/v3/models/operations"
	"log"
)

func main() {
    ctx := context.Background()

    s := v3.New(
        v3.WithSecurity("YOUR_SECRET_KEY_HERE"),
    )

    res, err := s.Contexts.List(ctx, operations.ContextsControllerListContextsRequest{
        Limit: v3.Pointer[float64](10.0),
        ID: v3.Pointer("tenant-prod-123"),
        Search: v3.Pointer("tenant"),
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.ListContextsResponseDto != nil {
        // handle response
    }
}
```

```TypeScript
import { Novu } from "@novu/api";

const novu = new Novu({
  secretKey: "YOUR_SECRET_KEY_HERE",
});

async function run() {
  const result = await novu.contexts.list({
    limit: 10,
    id: "tenant-prod-123",
    search: "tenant",
  });

  console.log(result);
}

run();
```

```C#
using Novu;
using Novu.Models.Components;
using Novu.Models.Requests;

var sdk = new NovuSDK(secretKey: "YOUR_SECRET_KEY_HERE");

ContextsControllerListContextsRequest req = new ContextsControllerListContextsRequest() {
    Limit = 10D,
    Id = "tenant-prod-123",
    Search = "tenant",
};

var res = await sdk.Contexts.ListAsync(req);

// handle response
```

```PHP
declare(strict_types=1);

require 'vendor/autoload.php';

use novu;
use novu\Models\Operations;

$sdk = novu\Novu::builder()
    ->setSecurity(
        'YOUR_SECRET_KEY_HERE'
    )
    ->build();

$request = new Operations\ContextsControllerListContextsRequest(
    limit: 10,
    id: 'tenant-prod-123',
    search: 'tenant',
);

$response = $sdk->contexts->list(
    request: $request
);

if ($response->listContextsResponseDto !== null) {
    // handle response
}
```

```Python
from novu_py import Novu


with Novu(
    secret_key="YOUR_SECRET_KEY_HERE",
) as novu:

    res = novu.contexts.list(request={
        "limit": 10,
        "id": "tenant-prod-123",
        "search": "tenant",
    })

    # Handle response
    print(res)
```

--------------------------------

### Success Response: Subscription Details

Source: https://docs.novu.co/api-reference/topics/retrieve-a-topic-subscription

Example 200 response containing subscription details, preferences, and context keys.

```JSON
{
  "id": "64f5e95d3d7946d80d0cb679",
  "identifier": "subscription-identifier",
  "name": "My Subscription",
  "preferences": [
    {
      "subscriptionId": "64f5e95d3d7946d80d0cb679",
      "enabled": true,
      "workflow": {
        "id": "64a1b2c3d4e5f6g7h8i9j0k1",
        "identifier": "welcome-email",
        "name": "Welcome Email Workflow",
        "critical": false,
        "severity": "high",
        "tags": [
          "user-onboarding",
          "email"
        ],
        "data": {
          "category": "onboarding",
          "priority": "high"
        }
      },
      "condition": {
        "and": [
          {
            "===": [
              {
                "var": "payload.tier"
              },
              "premium"
            ]
          }
        ]
      }
    }
  ],
  "contextKeys": [
    "tenant:org-a",
    "project:proj-123"
  ]
}
```

--------------------------------

### Run the project with dev:portless or start

Source: https://docs.novu.co/community/run-in-local-machine

Run the project. The recommended command is pnpm dev:portless, which starts the Dashboard, API, Worker, and shared packages through Portless proxies. The alternative is npm run start, which uses the Jarvis CLI menu.

```bash
pnpm dev:portless

```

```bash
npm run start

```

--------------------------------

### List Active Integrations via HTTP (curl, JavaScript, Java, Ruby)

Source: https://docs.novu.co/api-reference/integrations/list-active-integrations

HTTP client examples for the GET /v1/integrations/active endpoint. Replace <api-key> with your API key. The curl example uses the Authorization header; the JavaScript example uses fetch; the Java example uses Unirest; the Ruby example uses Net::HTTP with SSL enabled.

```bash
curl --request GET \
  --url https://api.novu.co/v1/integrations/active \
  --header 'Authorization: <api-key>'
```

```javascript
const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api.novu.co/v1/integrations/active', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
```

```java
HttpResponse<String> response = Unirest.get("https://api.novu.co/v1/integrations/active")
  .header("Authorization", "<api-key>")
  .asString();
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.novu.co/v1/integrations/active")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body
```

--------------------------------

### GET /v2/subscribers

Source: https://docs.novu.co/api-reference/pagination

Example of fetching a page of subscribers using cursor-based pagination with the REST API.

```APIDOC
## [GET] /v2/subscribers

### Description
Fetches a page of subscribers using cursor-based pagination. Pass the `after` cursor from a previous response to retrieve the next page.

### Method
GET

### Endpoint
/v2/subscribers

### Parameters
#### Query Parameters
- **limit** (number) - Optional - Items per page. Minimum `1`, maximum `100`. Default depends on the endpoint.
- **after** (string) - Optional - Cursor to fetch the page after a position. Use the `next` cursor from a previous response.
- **before** (string) - Optional - Cursor to fetch the page before a position. Use the `previous` cursor from a previous response.
- **orderBy** (string) - Optional - Field to sort by (endpoint-specific).
- **orderDirection** (string) - Optional - `ASC` or `DESC`.
- **includeCursor** (boolean) - Optional - Include the cursor item itself in the results.

### Request Example
```
curl -G https://api.novu.co/v2/subscribers \
  --header 'Authorization: ApiKey <NOVU_SECRET_KEY>' \
  --data-urlencode 'limit=50' \
  --data-urlencode 'after=eyJpZCI6IjY1...'
```

### Response
#### Success Response (200)
- **data** (array) - The array of items for the current page.
- **next** (string|null) - Cursor for the next page, or `null` if this is the last page.
- **previous** (string|null) - Cursor for the previous page, or `null` if this is the first page.
- **totalCount** (number) - Total matching items, counted up to a maximum of 50,000.
- **totalCountCapped** (boolean) - `true` when more than 50,000 results match and `totalCount` is capped.

#### Response Example
```
{
  "data": [ /* array of items */ ],
  "next": "eyJpZCI6IjY1...",
  "previous": null,
  "totalCount": 1240,
  "totalCountCapped": false
}
```
```

--------------------------------

### Install Novu .NET SDK

Source: https://docs.novu.co/platform/sdks/server/dotnet

Installs the Novu .NET SDK package via the .NET CLI.

```bash
dotnet add package Novu

```

--------------------------------

### Publish resources to target environment (Go)

Source: https://docs.novu.co/api-reference/environments/publish-resources-to-target-environment

Uses the Novu Go SDK to publish resources to a target environment. Requires a secret key and the target environment ID. The example sets the source environment ID and performs the publish operation.

```go
package main

import(
	"context"
	"github.com/novuhq/novu-go/v3"
	"github.com/novuhq/novu-go/v3/models/components"
	"log"
)

func main() {
    ctx := context.Background()

    s := v3.New(
        v3.WithSecurity("YOUR_SECRET_KEY_HERE"),
    )

    res, err := s.Environments.Publish(ctx, 
```

--------------------------------

### Install @novu/react with npm

Source: https://docs.novu.co/agents/channels/web-chat

Install the React client for Web Chat. Requires React 18 or later (^18.0.0 or ^19.0.0). Place NovuProvider above the chat; useWebChat gets the Novu client from that context.

```bash
npm install @novu/react

```

--------------------------------

### Example FIFO request body

Source: https://docs.novu.co/guides/webhook-connectors/fifo-endpoint

The shape of the raw HTTP request body that the receiver gets after the transformation. The payload wraps the resource in an envelope.

```json
{
  "data": [
    {
      "eventType": "message.sent",
      "payload": {
        "type": "message.sent",
        "object": "message",
        "data": {
          "object": {
            "subscriberId": "subscriber-123"
          }
        }
      }
    }
  ]
}
```

--------------------------------

### Create a channel connection with the Novu Go SDK

Source: https://docs.novu.co/api-reference/channel-connections/create-a-channel-connection

Use this Go example to create a channel connection by calling the ChannelConnections.Create method with a CreateChannelConnectionRequestDto payload. The example sets an identifier, subscriber ID, context map, connection mode, integration identifier, workspace, and auth. Replace YOUR_SECRET_KEY_HERE with your actual Novu secret key before running.

```go
package main

import(
	"context"
	"github.com/novuhq/novu-go/v3"
	"github.com/novuhq/novu-go/v3/models/components"
	"log"
)

func main() {
    ctx := context.Background()

    s := v3.New(
        v3.WithSecurity("YOUR_SECRET_KEY_HERE"),
    )

    res, err := s.ChannelConnections.Create(ctx, components.CreateChannelConnectionRequestDto{
        Identifier: v3.Pointer(
```

```go
package main

import(
	"context"
	"github.com/novuhq/novu-go/v3"
	"github.com/novuhq/novu-go/v3/models/components"
	"log"
)

func main() {
    ctx := context.Background()

    s := v3.New(
        v3.WithSecurity("YOUR_SECRET_KEY_HERE"),
    )

    res, err := s.ChannelConnections.Create(ctx, components.CreateChannelConnectionRequestDto{
        Identifier: v3.Pointer("slack-prod-user123-abc4"),
        SubscriberID: v3.Pointer("subscriber-123"),
        Context: map[string]components.CreateChannelConnectionRequestDtoContext{
            
```

```go
package main

import(
	"context"
	"github.com/novuhq/novu-go/v3"
	"github.com/novuhq/novu-go/v3/models/components"
	"log"
)

func main() {
    ctx := context.Background()

    s := v3.New(
        v3.WithSecurity("YOUR_SECRET_KEY_HERE"),
    )

    res, err := s.ChannelConnections.Create(ctx, components.CreateChannelConnectionRequestDto{
        Identifier: v3.Pointer("slack-prod-user123-abc4"),
        SubscriberID: v3.Pointer("subscriber-123"),
        Context: map[string]components.CreateChannelConnectionRequestDtoContext{
            "key": components.CreateCreateChannelConnectionRequestDtoContextStr(
                
```

```go
org-acme",
            ),
        },
        ConnectionMode: components.ConnectionModeShared.ToPointer(),
        IntegrationIdentifier: "slack-prod",
        Workspace: components.WorkspaceDto{
            ID: "T123456",
            Name: v3.Pointer("Acme HQ"),
            BotUserID: v3.Pointer("U0123456789"),
        },
        Auth: components.CreateChannelConnectionRequestDtoAuth{
            Type: components.AuthTypeOauth2.ToPointer(),
            Token: v3.Pointer("xoxb-1234567890-abcdefghijklmnopqrstuvwx"),
        },
    }, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil
```

--------------------------------

### cURL Example: List Subscriber Topics

Source: https://docs.novu.co/api-reference/subscribers/retrieve-subscriber-subscriptions

Sends a GET request to the API endpoint with an API key header to list subscriber topics.

```bash
curl --request GET \
  --url https://api.novu.co/v2/subscribers/{subscriberId}/subscriptions \
  --header 'Authorization: <api-key>'
```

--------------------------------

### Install and initialize @novu/js

Source: https://docs.novu.co/platform/build-with-ai/skills

Install the vanilla JS package and initialize the Novu client with your application identifier and subscriber ID.

```bash
npm install @novu/js

```

```javascript
import { Novu } from "@novu/js";

const novu = new Novu({
  applicationIdentifier: "YOUR_NOVU_APP_ID",
  subscriberId: "subscriber-123",
});

```

--------------------------------

### Java Unirest Example: List Subscriber Topics

Source: https://docs.novu.co/api-reference/subscribers/retrieve-subscriber-subscriptions

Uses Unirest to send a GET request with an API key header and returns the response as a string.

```java
HttpResponse<String> response = Unirest.get("https://api.novu.co/v2/subscribers/{subscriberId}/subscriptions")
  .header("Authorization", "<api-key>")
  .asString();
```

--------------------------------

### Go SDK Example: List Subscriber Topics

Source: https://docs.novu.co/api-reference/subscribers/retrieve-subscriber-subscriptions

Uses the Novu Go SDK to list subscriber topics with context keys and a limit. Requires a secret key and handles the response.

```go
package main

import(
	"context"
	"github.com/novuhq/novu-go/v3"
	"github.com/novuhq/novu-go/v3/models/operations"
	"log"
)

func main() {
    ctx := context.Background()

    s := v3.New(
        v3.WithSecurity("YOUR_SECRET_KEY_HERE"),
    )

    res, err := s.Subscribers.Topics.List(ctx, operations.SubscribersControllerListSubscriberTopicsRequest{
        SubscriberID: "<id>",
        Limit: v3.Pointer[float64](10.0),
        ContextKeys: []string{
            "tenant:org-123",
            "region:us-east-1",
        },
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.ListTopicSubscriptionsResponseDto != nil {
        // handle response
    }
}
```

--------------------------------

### JavaScript fetch Example: List Subscriber Topics

Source: https://docs.novu.co/api-reference/subscribers/retrieve-subscriber-subscriptions

Uses fetch to send a GET request with an API key header and logs the response or error.

```javascript
const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api.novu.co/v2/subscribers/{subscriberId}/subscriptions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
```

--------------------------------

### Run the Remix development server

Source: https://docs.novu.co/platform/quickstart/remix

Starts the development server. After running, a bell icon appears in the navbar; clicking it opens the notification inbox UI.

```bash
npm run dev

```

--------------------------------

### Context Keys Example

Source: https://docs.novu.co/api-reference/topics/retrieve-a-topic-subscription

Example of contextKeys array that scopes a subscription, e.g., tenant:org-a and project:proj-123.

```json
["tenant:org-a", "project:proj-123"]
```

--------------------------------

### Retrieve Subscriber Notifications Feed (PHP, Go, Java, Ruby)

Source: https://docs.novu.co/api-reference/subscribers/retrieve-subscriber-notifications

Send a GET request to the Novu API endpoint to retrieve a subscriber's notifications feed. Replace {subscriberId} with the actual subscriber ID and <api-key> with your API key. The PHP example prints cURL errors or the response body; the Go example prints the response body; the Java example uses Unirest; the Ruby example uses Net::HTTP with SSL enabled.

```php
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.novu.co/v1/subscribers/{subscriberId}/notifications/feed",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.novu.co/v1/subscribers/{subscriberId}/notifications/feed"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
```

```java
HttpResponse<String> response = Unirest.get("https://api.novu.co/v1/subscribers/{subscriberId}/notifications/feed")
  .header("Authorization", "<api-key>")
  .asString();
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.novu.co/v1/subscribers/{subscriberId}/notifications/feed")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body
```
Tokens:
Raw