novu-trigger-notification

Files (6)

• SKILL.md
• best-practices.md · references/
• bulk-trigger-examples.md · references/
• installation.md · references/
• single-trigger-examples.md · references/
• topic-trigger-examples.md · references/

SKILL.md (first lines)

# Trigger Notification

Send notifications by triggering Novu workflows. Supports single, bulk, broadcast, and topic-based delivery.

## SDK Setup

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

const novu = new Novu({
  secretKey: process.env.NOVU_SECRET_KEY,
});
```

## Single Trigger

Send a notification to one subscriber:

```typescript
const result = await novu.trigger({
  workflowId: "welcome-email",
  to: "subscriber-123",
  payload: {
    userName: "Jane",
    activationLink: "https://app.example.com/activate",
  },
});
```

### Trigger with Inline Subscriber Creation

If the subscriber doesn't exist yet, provide the full object — Novu upserts the subscriber:

```typescript
const result = await novu.trigger({
  workflowId: "welcome-email",
  to: {
    subscriberId: "user-456",
    email: "jane@example.com",
    firstName: "Jane",
    lastName: "Doe",
  },
  payload: { userName: "Jane" },
});
```

### Trigger with Transaction ID

Use custom `transactionId` for idempotency:

```typescript
const result = await novu.trigger({
  workflowId: "order-update",
  to: "subscriber-123",
  payload: { orderId: "order-789" },
  transactionId: "unique-tx-id-abc",
});
```

## Bulk Trigger

Send up to **100 events** in a single request:

```typescript
const result = await novu.triggerBulk({
  events: [
    {
      workflowId: "welcome-email",
      to: "subscriber-1",
      payload: { userName: "Alice" },
    },
    {
      workflowId: "welcome-email",
      to: "subscriber-2",
      payload: { userName: "Bob" },
    },
  ],
});
```

## Broadcast

Send to **all subscribers** in the environment:

```typescript
const result = await novu.triggerBroadcast({
  // here name field is for workflowId
  name: "system-announcement",
  payload: {
    message: "Scheduled maintenance at 2am UTC",
  },
});
```

## Topic-Based Trigger

Send to all subscribers in a topic:

```typescript
const result = await novu.trigger({
  workflowId: "project-update",
  to: [{
    type: "Topic",
    topicKey: "project-alpha-watchers",
  }],
  payload: { update: "New release deployed" },
});
```

## Cancel a Trigger

Cancel delayed or digested notifications using the `transactionId`:

```typescript
await novu.cancel("unique-tx-id-abc");
```

## Trigger Parameters

From novuhq/skills, MIT.

More from novuhq/skills