POST
/
v1
/
workflows
  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" }]
  }'

{
  "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": {}
  }
}

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

E.g ApiKey 18d2e625f05d80e

  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" }]
  }'

{
  "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
​
notificationGroup
object
​
tags
string[]
​
description
string
Maximum length: 1000
​
active
boolean
​
draft
boolean
deprecated
​
critical
boolean
​
preferenceSettings
object
​
blueprintId
string
​
data
object

Response

201
application/json
Created
​
name
string
required
​
description
string
required
​
active
boolean
required
​
draft
boolean
required
​
preferenceSettings
object
required
​
critical
boolean
required
​
tags
string[]
required
​
steps
object[]
required
​
_organizationId
string
required
​
_creatorId
string
required
​
_environmentId
string
required
​
triggers
object[]
required
​
_notificationGroupId
string
required
​
deleted
boolean
required
​
deletedAt
string
required
​
deletedBy
string
required
​
_id
string
​
_parentId
string
​
notificationGroup
object
​
data
object
​
workflowIntegrationStatus
object

Was this page helpful?