docs/api-reference/workflows/workflow-schema.mdx - next - githubmirror/novu

docs/api-reference/workflows/workflow-schema.mdx

33 строки2 KB

Dima Grossman

docs(docs): nest API reference domains in collapsible sidebar groups fixes DOC-413 (#11886)

12 июл 2026, 15:47

12 июл 2026, 15:47149638c

---
title: Workflow schema
sidebarTitle: Schema
description: "Reference the Novu workflow schema used in API requests and responses. Review fields, data types, and object structure for this resource."
---

### Workflow

In Novu, a workflow defines the logic for delivering notifications based on specific events. It consists of configurable steps that control timing, conditions, and which channels to use, such as email, SMS, or in-app messages. Workflows can be built visually in the dashboard or programmatically using the Novu Framework. Each workflow has a unique identifier, supports environment syncing, and provides real-time visibility through the Activity Feed for monitoring and debugging.. Read more about workflows on [workflows concept page](/platform/concepts/workflows). 

| Field | Type | Description |
| --- | --- | --- |
| `id` | `string` |  |
| `name` | `string` |  |
| `description` | `string` |  |
| `active` | `boolean` |  |
| `draft` | `boolean` |  |
| `preferenceSettings` | `SubscriberPreferenceChannels` |  |
| `critical` | `boolean` |  |
| `tags` | `string[]` |  |
| `steps` | `NotificationStepDto[]` |  |
| `organizationId` | `string` |  |
| `creatorId` | `string` |  |
| `environmentId` | `string` |  |
| `triggers` | `NotificationTrigger[]` |  |
| `notificationGroupId` | `string` |  |
| `parentId` | `string` |  |
| `deleted` | `boolean` |  |
| `deletedAt` | `string` |  |
| `deletedBy` | `string` |  |
| `notificationGroup` | `NotificationGroup` |  |
| `data` | `WorkflowResponseData` |  |
| `workflowIntegrationStatus` | `WorkflowIntegrationStatus` |  |