Create workflow

Enter your API key in the Authorization field like the example shown below:

E.g ApiKey 18d2e625f05d80e

cURL

  curl --request POST \
  --url https://api.novu.co/v1/workflows \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "<name>",
    "notificationGroupId":"<notificationGroupId>",
    "steps": [{ "steps" }]
  }'

Response

{
  "data": {
    "_id": "string",
    "name": "string",
    "description": "string",
    "active": true,
    "draft": true,
    "preferenceSettings": {
      "email": true,
      "sms": true,
      "in_app": true,
      "chat": true,
      "push": true
    },
    "critical": true,
    "tags": ["string"],
    "steps": [
      {
        "_id": "string",
        "uuid": "string",
        "name": "string",
        "_templateId": "string",
        "active": true,
        "shouldStopOnFail": true,
        "template": {},
        "filters": [
          {
            "isNegated": true,
            "type": "BOOLEAN",
            "value": "AND",
            "children": [
              {
                "field": "string",
                "value": "string",
                "operator": "LARGER",
                "on": "subscriber"
              }
            ]
          }
        ],
        "_parentId": {},
        "metadata": {
          "amount": 0,
          "unit": "seconds",
          "digestKey": "string",
          "type": "regular",
          "backoff": true,
          "backoffAmount": 0,
          "backoffUnit": "seconds",
          "updateMode": true
        },
        "replyCallback": {}
      }
    ],
    "_organizationId": "string",
    "_creatorId": "string",
    "_environmentId": "string",
    "triggers": [
      {
        "type": "string",
        "identifier": "string",
        "variables": [
          {
            "name": "string"
          }
        ],
        "subscriberVariables": [
          {
            "name": "string"
          }
        ]
      }
    ],
    "_notificationGroupId": "string",
    "_parentId": "string",
    "deleted": true,
    "deletedAt": "string",
    "deletedBy": "string",
    "notificationGroup": {
      "_id": "string",
      "name": "string",
      "_environmentId": "string",
      "_organizationId": "string",
      "_parentId": "string"
    },
    "data": {},
    "workflowIntegrationStatus": {}
  }
}

Authorizations

Authorization

string

header

required

API key authentication. Allowed headers-- "Authorization: ApiKey <api_key>".

Body

application/json

name

string

required

notificationGroupId

string

required

steps

object[]

required

Show child attributes

steps._id

string

steps.uuid

string

steps.name

string

steps._templateId

string

steps.active

boolean

steps.shouldStopOnFail

boolean

steps.template

object

steps.filters

object[]

Show child attributes

steps.filters.isNegated

boolean

required

steps.filters.type

enum<string>

required

Available options:

BOOLEAN,

TEXT,

DATE,

NUMBER,

STATEMENT,

LIST,

MULTI_LIST,

GROUP

steps.filters.value

enum<string>

required

Available options:

AND,

OR

steps.filters.children

object[]

required

Show child attributes

steps.filters.children.field

string

required

steps.filters.children.value

string

required

steps.filters.children.operator

enum<string>

required

Available options:

LARGER,

SMALLER,

LARGER_EQUAL,

SMALLER_EQUAL,

EQUAL,

NOT_EQUAL,

ALL_IN,

ANY_IN,

NOT_IN,

BETWEEN,

NOT_BETWEEN,

LIKE,

NOT_LIKE,

IN

steps.filters.children.on

enum<string>

required

Available options:

subscriber,

payload

steps._parentId

object

steps.metadata

object

• Option 1
• Option 2
• Option 3
• Option 4

Show child attributes

steps.metadata.type

enum<string>

required

Available options:

regular,

backoff

steps.metadata.amount

number

steps.metadata.unit

enum<string>

Available options:

seconds,

minutes,

hours,

days,

weeks,

months

steps.metadata.digestKey

string

steps.metadata.backoff

boolean

steps.metadata.backoffAmount

number

steps.metadata.backoffUnit

enum<string>

Available options:

seconds,

minutes,

hours,

days,

weeks,

months

steps.metadata.updateMode

boolean

steps.replyCallback

object

steps.variants

object

Show child attributes

steps.variants._id

string

steps.variants.uuid

string

steps.variants.name

string

steps.variants._templateId

string

steps.variants.active

boolean

steps.variants.shouldStopOnFail

boolean

steps.variants.template

object

steps.variants.filters

object[]

Show child attributes

steps.variants.filters.isNegated

boolean

required

steps.variants.filters.type

enum<string>

required

Available options:

BOOLEAN,

TEXT,

DATE,

NUMBER,

STATEMENT,

LIST,

MULTI_LIST,

GROUP

steps.variants.filters.value

enum<string>

required

Available options:

AND,

OR

steps.variants.filters.children

object[]

required

Show child attributes

steps.variants.filters.children.field

string

required

steps.variants.filters.children.value

string

required

steps.variants.filters.children.operator

enum<string>

required

Available options:

LARGER,

SMALLER,

LARGER_EQUAL,

SMALLER_EQUAL,

EQUAL,

NOT_EQUAL,

ALL_IN,

ANY_IN,

NOT_IN,

BETWEEN,

NOT_BETWEEN,

LIKE,

NOT_LIKE,

IN

steps.variants.filters.children.on

enum<string>

required

Available options:

subscriber,

payload

steps.variants._parentId

object

steps.variants.metadata

object

• Option 1
• Option 2
• Option 3
• Option 4

Show child attributes

steps.variants.metadata.type

enum<string>

required

Available options:

regular,

backoff

steps.variants.metadata.amount

number

steps.variants.metadata.unit

enum<string>

Available options:

seconds,

minutes,

hours,

days,

weeks,

months

steps.variants.metadata.digestKey

string

steps.variants.metadata.backoff

boolean

steps.variants.metadata.backoffAmount

number

steps.variants.metadata.backoffUnit

enum<string>

Available options:

seconds,

minutes,

hours,

days,

weeks,

months

steps.variants.metadata.updateMode

boolean

steps.variants.replyCallback

object

notificationGroup

object

tags

string[]

description

string

Maximum length: 1000

active

boolean

draft

boolean

deprecated

critical

boolean

preferenceSettings

object

Show child attributes

preferenceSettings.email

boolean

preferenceSettings.sms

boolean

preferenceSettings.in_app

boolean

preferenceSettings.chat

boolean

preferenceSettings.push

boolean

blueprintId

string

data

object

Response

201

application/json

Created

name

string

required

description

string

required

active

boolean

required

draft

boolean

required

preferenceSettings

object

required

Show child attributes

preferenceSettings.email

boolean

preferenceSettings.sms

boolean

preferenceSettings.in_app

boolean

preferenceSettings.chat

boolean

preferenceSettings.push

boolean

critical

boolean

required

tags

string[]

required

steps

object[]

required

Show child attributes

steps._id

string

steps.uuid

string

steps.name

string

steps._templateId

string

steps.active

boolean

steps.shouldStopOnFail

boolean

steps.template

object

steps.filters

object[]

Show child attributes

steps.filters.isNegated

boolean

required

steps.filters.type

enum<string>

required

Available options:

BOOLEAN,

TEXT,

DATE,

NUMBER,

STATEMENT,

LIST,

MULTI_LIST,

GROUP

steps.filters.value

enum<string>

required

Available options:

AND,

OR

steps.filters.children

object[]

required

Show child attributes

steps.filters.children.field

string

required

steps.filters.children.value

string

required

steps.filters.children.operator

enum<string>

required

Available options:

LARGER,

SMALLER,

LARGER_EQUAL,

SMALLER_EQUAL,

EQUAL,

NOT_EQUAL,

ALL_IN,

ANY_IN,

NOT_IN,

BETWEEN,

NOT_BETWEEN,

LIKE,

NOT_LIKE,

IN

steps.filters.children.on

enum<string>

required

Available options:

subscriber,

payload

steps._parentId

object

steps.metadata

object

• Option 1
• Option 2
• Option 3
• Option 4

Show child attributes

steps.metadata.type

enum<string>

required

Available options:

regular,

backoff

steps.metadata.amount

number

steps.metadata.unit

enum<string>

Available options:

seconds,

minutes,

hours,

days,

weeks,

months

steps.metadata.digestKey

string

steps.metadata.backoff

boolean

steps.metadata.backoffAmount

number

steps.metadata.backoffUnit

enum<string>

Available options:

seconds,

minutes,

hours,

days,

weeks,

months

steps.metadata.updateMode

boolean

steps.replyCallback

object

steps.variants

object

Show child attributes

steps.variants._id

string

steps.variants.uuid

string

steps.variants.name

string

steps.variants._templateId

string

steps.variants.active

boolean

steps.variants.shouldStopOnFail

boolean

steps.variants.template

object

steps.variants.filters

object[]

Show child attributes

steps.variants.filters.isNegated

boolean

required

steps.variants.filters.type

enum<string>

required

Available options:

BOOLEAN,

TEXT,

DATE,

NUMBER,

STATEMENT,

LIST,

MULTI_LIST,

GROUP

steps.variants.filters.value

enum<string>

required

Available options:

AND,

OR

steps.variants.filters.children

object[]

required

Show child attributes

steps.variants.filters.children.field

string

required

steps.variants.filters.children.value

string

required

steps.variants.filters.children.operator

enum<string>

required

Available options:

LARGER,

SMALLER,

LARGER_EQUAL,

SMALLER_EQUAL,

EQUAL,

NOT_EQUAL,

ALL_IN,

ANY_IN,

NOT_IN,

BETWEEN,

NOT_BETWEEN,

LIKE,

NOT_LIKE,

IN

steps.variants.filters.children.on

enum<string>

required

Available options:

subscriber,

payload

steps.variants._parentId

object

steps.variants.metadata

object

• Option 1
• Option 2
• Option 3
• Option 4

Show child attributes

steps.variants.metadata.type

enum<string>

required

Available options:

regular,

backoff

steps.variants.metadata.amount

number

steps.variants.metadata.unit

enum<string>

Available options:

seconds,

minutes,

hours,

days,

weeks,

months

steps.variants.metadata.digestKey

string

steps.variants.metadata.backoff

boolean

steps.variants.metadata.backoffAmount

number

steps.variants.metadata.backoffUnit

enum<string>

Available options:

seconds,

minutes,

hours,

days,

weeks,

months

steps.variants.metadata.updateMode

boolean

steps.variants.replyCallback

object

_organizationId

string

required

_creatorId

string

required

_environmentId

string

required

triggers

object[]

required

Show child attributes

triggers.type

enum<string>

required

Available options:

event

triggers.identifier

string

required

triggers.variables

object[]

required

Show child attributes

triggers.variables.name

string

required

triggers.subscriberVariables

object[]

Show child attributes

triggers.subscriberVariables.name

string

required

_notificationGroupId

string

required

deleted

boolean

required

deletedAt

string

required

deletedBy

string

required

_id

string

_parentId

string

notificationGroup

object

Show child attributes

notificationGroup.name

string

required

notificationGroup._environmentId

string

required

notificationGroup._organizationId

string

required

notificationGroup._id

string

notificationGroup._parentId

string

data

object

workflowIntegrationStatus

object