Create workflow

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

E.g ApiKey 18d2e625f05d80e

Body

application/json

name

string

required

notificationGroupId

string

required

steps

object[]

required

Show child attributes

steps._id

string

steps._parentId

object

steps._templateId

string

steps.active

boolean

steps.filters

object[]

Show child attributes

steps.filters.children

object[]

required

Show child attributes

steps.filters.children.field

string

required

steps.filters.children.on

enum<string>

required

Available options:

subscriber,

payload

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.value

string

required

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.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.backoff

boolean

steps.metadata.backoffAmount

number

steps.metadata.backoffUnit

enum<string>

Available options:

seconds,

minutes,

hours,

days,

weeks,

months

steps.metadata.digestKey

string

steps.metadata.unit

enum<string>

Available options:

seconds,

minutes,

hours,

days,

weeks,

months

steps.metadata.updateMode

boolean

steps.name

string

steps.replyCallback

object

steps.shouldStopOnFail

boolean

steps.template

object

steps.uuid

string

steps.variants

object

Show child attributes

steps.variants._id

string

steps.variants._parentId

object

steps.variants._templateId

string

steps.variants.active

boolean

steps.variants.filters

object[]

Show child attributes

steps.variants.filters.children

object[]

required

Show child attributes

steps.variants.filters.children.field

string

required

steps.variants.filters.children.on

enum<string>

required

Available options:

subscriber,

payload

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.value

string

required

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.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.backoff

boolean

steps.variants.metadata.backoffAmount

number

steps.variants.metadata.backoffUnit

enum<string>

Available options:

seconds,

minutes,

hours,

days,

weeks,

months

steps.variants.metadata.digestKey

string

steps.variants.metadata.unit

enum<string>

Available options:

seconds,

minutes,

hours,

days,

weeks,

months

steps.variants.metadata.updateMode

boolean

steps.variants.name

string

steps.variants.replyCallback

object

steps.variants.shouldStopOnFail

boolean

steps.variants.template

object

steps.variants.uuid

string

active

boolean

blueprintId

string

critical

boolean

data

object

description

string

Maximum length: 1000

draft

boolean

deprecated

preferenceSettings

object

Show child attributes

preferenceSettings.chat

boolean

preferenceSettings.email

boolean

preferenceSettings.in_app

boolean

preferenceSettings.push

boolean

preferenceSettings.sms

boolean

tags

string[]

Response

201 - application/json

data

object

Show child attributes

data._creatorId

string

required

data._environmentId

string

required

data._notificationGroupId

string

required

data._organizationId

string

required

data.active

boolean

required

data.critical

boolean

required

data.deleted

boolean

required

data.deletedAt

string

required

data.deletedBy

string

required

data.description

string

required

data.draft

boolean

required

data.name

string

required

data.preferenceSettings

object

required

Show child attributes

data.preferenceSettings.chat

boolean

data.preferenceSettings.email

boolean

data.preferenceSettings.in_app

boolean

data.preferenceSettings.push

boolean

data.preferenceSettings.sms

boolean

data.steps

object[]

required

Show child attributes

data.steps._id

string

data.steps._parentId

object

data.steps._templateId

string

data.steps.active

boolean

data.steps.filters

object[]

Show child attributes

data.steps.filters.children

object[]

required

Show child attributes

data.steps.filters.children.field

string

required

data.steps.filters.children.on

enum<string>

required

Available options:

subscriber,

payload

data.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

data.steps.filters.children.value

string

required

data.steps.filters.isNegated

boolean

required

data.steps.filters.type

enum<string>

required

Available options:

BOOLEAN,

TEXT,

DATE,

NUMBER,

STATEMENT,

LIST,

MULTI_LIST,

GROUP

data.steps.filters.value

enum<string>

required

Available options:

AND,

OR

data.steps.metadata

object

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

Show child attributes

data.steps.metadata.type

enum<string>

required

Available options:

regular,

backoff

data.steps.metadata.amount

number

data.steps.metadata.backoff

boolean

data.steps.metadata.backoffAmount

number

data.steps.metadata.backoffUnit

enum<string>

Available options:

seconds,

minutes,

hours,

days,

weeks,

months

data.steps.metadata.digestKey

string

data.steps.metadata.unit

enum<string>

Available options:

seconds,

minutes,

hours,

days,

weeks,

months

data.steps.metadata.updateMode

boolean

data.steps.name

string

data.steps.replyCallback

object

data.steps.shouldStopOnFail

boolean

data.steps.template

object

data.steps.uuid

string

data.steps.variants

object

Show child attributes

data.steps.variants._id

string

data.steps.variants._parentId

object

data.steps.variants._templateId

string

data.steps.variants.active

boolean

data.steps.variants.filters

object[]

Show child attributes

data.steps.variants.filters.children

object[]

required

Show child attributes

data.steps.variants.filters.isNegated

boolean

required

data.steps.variants.filters.type

enum<string>

required

Available options:

BOOLEAN,

TEXT,

DATE,

NUMBER,

STATEMENT,

LIST,

MULTI_LIST,

GROUP

data.steps.variants.filters.value

enum<string>

required

Available options:

AND,

OR

data.steps.variants.metadata

object

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

Show child attributes

data.steps.variants.metadata.type

enum<string>

required

Available options:

regular,

backoff

data.steps.variants.metadata.amount

number

data.steps.variants.metadata.backoff

boolean

data.steps.variants.metadata.backoffAmount

number

data.steps.variants.metadata.backoffUnit

enum<string>

Available options:

seconds,

minutes,

hours,

days,

weeks,

months

data.steps.variants.metadata.digestKey

string

data.steps.variants.metadata.unit

enum<string>

Available options:

seconds,

minutes,

hours,

days,

weeks,

months

data.steps.variants.metadata.updateMode

boolean

data.steps.variants.name

string

data.steps.variants.replyCallback

object

data.steps.variants.shouldStopOnFail

boolean

data.steps.variants.template

object

data.steps.variants.uuid

string

data.tags

string[]

required

data.triggers

object[]

required

Show child attributes

data.triggers.identifier

string

required

data.triggers.type

enum<string>

required

Available options:

event

data.triggers.variables

object[]

required

Show child attributes

data.triggers.variables.name

string

required

data.triggers.subscriberVariables

object[]

Show child attributes

data.triggers.subscriberVariables.name

string

required

data._id

string

data._parentId

string

data.data

object

data.notificationGroup

object

Show child attributes

data.notificationGroup._environmentId

string

required

data.notificationGroup._organizationId

string

required

data.notificationGroup.name

string

required

data.notificationGroup._id

string

data.notificationGroup._parentId

string

data.workflowIntegrationStatus

object