Novu · Example Payload

Novu Workflow Response Example

Onboarding sequence — email + in-app + digest

onboardinggrowth

Novu Workflow Response Example is an example object payload from Novu, with 11 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

_idnamedescriptiontagsstepsactivedraftcriticalpreferenceSettingscreatedAtupdatedAt

Example Payload

Raw ↑ 
{
  "_id": "64f1c2c3d4e5f6789abcdef0",
  "name": "Welcome Onboarding",
  "description": "Onboarding sequence \u2014 email + in-app + digest",
  "tags": [
    "onboarding",
    "growth"
  ],
  "steps": [
    {
      "type": "email",
      "template": {
        "subject": "Welcome to Acme, {{firstName}}!"
      }
    },
    {
      "type": "in_app",
      "template": {
        "content": "Welcome aboard, {{firstName}} \ud83d\udc4b"
      }
    }
  ],
  "active": true,
  "draft": false,
  "critical": false,
  "preferenceSettings": {
    "email": true,
    "in_app": true,
    "sms": false,
    "chat": false,
    "push": false
  },
  "createdAt": "2026-05-01T12:00:00Z",
  "updatedAt": "2026-05-20T15:30:00Z"
}