Workflows
Get workflow
- API Overview
- API Rate Limiting
Events
Subscribers
Topics
Notification
Workflows
Workflow Overrides
Workflow groups
Integrations
Layouts
Environments
Changes
Execution Details
Feeds
Tenants
Organizations
Messages
Workflows
Get workflow
Workflow was previously named notification template
GET
/
v1
/
workflows
/
{workflowId}
Authorization
string
*
Authorization
Required
string
API key authentication. Allowed headers-- "Authorization: ApiKey <api_key>".
workflowId
string
*
workflowId
Required
string
curl --request GET \
--url https://api.novu.co/v1/workflows/{workflowId} \
--header 'Authorization: <authorization>'
{
"data": {
"preferenceSettings": {
"email": true,
"sms": true,
"in_app": true,
"chat": true,
"push": true
},
"_id": "7u83d3123t3a9e261ba9934r8",
"name": "chat with Discord",
"active": true,
"draft": false,
"critical": true,
"isBlueprint": false,
"_notificationGroupId": "641eddefda8256b93f750e0b",
"tags": [],
"triggers": [
{
"type": "event",
"identifier": "chat-with-discord",
"variables": [
{
"name": "chatMsg",
"type": "String",
"_id": "7u83d3123t3a9e261ba9934r8",
"id": "7u83d3123t3a9e261ba9934r8"
}
],
"reservedVariables": [],
"subscriberVariables": [],
"_id": "7u83d3123t3a9e261ba9934r8",
"id": "7u83d3123t3a9e261ba9934r8"
}
],
"steps": [
{
"metadata": {
"timed": {
"weekDays": [],
"monthDays": []
}
},
"active": true,
"shouldStopOnFail": false,
"uuid": "9799f1c9-0de2-4252-8921-01840a71a741",
"name": "Chat",
"filters": [
{
"children": [],
"_id": "7u83d3123t3a9e261ba99376e",
"id": "7u83d3123t3a9e261ba993999"
}
],
"_templateId": "6533d389306c4d8cf7853557",
"_parentId": null,
"_id": "99u3d3123t3a9e261ba993r45",
"id": "90uid3123t3a9e261ba9978yu",
"template": {
"_id": "r567d3123t3a9e261ba9990as",
"type": "chat",
"active": true,
"subject": "",
"variables": [
{
"name": "chatMsg",
"type": "String",
"required": false,
"_id": "2383d3123t3a9e261ba997878",
"id": "8711d389306c4d8cf7859090"
}
],
"content": "{{chatMsg}}",
"contentType": "editor",
"_environmentId": "234edtyuda8256b93f7567f90",
"_organizationId": "333tydefda8256b93f753yh6",
"_creatorId": "63123ee5d9af70da9f6a2e4",
"_feedId": null,
"_layoutId": null,
"deleted": false,
"createdAt": "2023-10-21T13:35:05.825Z",
"updatedAt": "2023-10-21T13:35:18.156Z",
"__v": 0,
"id": "7u83d3123t3a9e261ba9934r8"
}
}
],
"_environmentId": "234edtyuda8256b93f7567f90",
"_organizationId": "333tydefda8256b93f753yh6",
"_creatorId": "63123ee5d9af70da9f6a2e4",
"deleted": false,
"createdAt": "2023-10-21T13:34:48.130Z",
"updatedAt": "2023-10-21T13:35:18.994Z",
"__v": 0,
"id": "7u83d3123t3a9e261ba9934r8"
}
}
Enter your API key in the Authorization field like the example shown below:
E.g ApiKey 18d2e625f05d80e
curl --request GET \
--url https://api.novu.co/v1/workflows/{workflowId} \
--header 'Authorization: <authorization>'
{
"data": {
"preferenceSettings": {
"email": true,
"sms": true,
"in_app": true,
"chat": true,
"push": true
},
"_id": "7u83d3123t3a9e261ba9934r8",
"name": "chat with Discord",
"active": true,
"draft": false,
"critical": true,
"isBlueprint": false,
"_notificationGroupId": "641eddefda8256b93f750e0b",
"tags": [],
"triggers": [
{
"type": "event",
"identifier": "chat-with-discord",
"variables": [
{
"name": "chatMsg",
"type": "String",
"_id": "7u83d3123t3a9e261ba9934r8",
"id": "7u83d3123t3a9e261ba9934r8"
}
],
"reservedVariables": [],
"subscriberVariables": [],
"_id": "7u83d3123t3a9e261ba9934r8",
"id": "7u83d3123t3a9e261ba9934r8"
}
],
"steps": [
{
"metadata": {
"timed": {
"weekDays": [],
"monthDays": []
}
},
"active": true,
"shouldStopOnFail": false,
"uuid": "9799f1c9-0de2-4252-8921-01840a71a741",
"name": "Chat",
"filters": [
{
"children": [],
"_id": "7u83d3123t3a9e261ba99376e",
"id": "7u83d3123t3a9e261ba993999"
}
],
"_templateId": "6533d389306c4d8cf7853557",
"_parentId": null,
"_id": "99u3d3123t3a9e261ba993r45",
"id": "90uid3123t3a9e261ba9978yu",
"template": {
"_id": "r567d3123t3a9e261ba9990as",
"type": "chat",
"active": true,
"subject": "",
"variables": [
{
"name": "chatMsg",
"type": "String",
"required": false,
"_id": "2383d3123t3a9e261ba997878",
"id": "8711d389306c4d8cf7859090"
}
],
"content": "{{chatMsg}}",
"contentType": "editor",
"_environmentId": "234edtyuda8256b93f7567f90",
"_organizationId": "333tydefda8256b93f753yh6",
"_creatorId": "63123ee5d9af70da9f6a2e4",
"_feedId": null,
"_layoutId": null,
"deleted": false,
"createdAt": "2023-10-21T13:35:05.825Z",
"updatedAt": "2023-10-21T13:35:18.156Z",
"__v": 0,
"id": "7u83d3123t3a9e261ba9934r8"
}
}
],
"_environmentId": "234edtyuda8256b93f7567f90",
"_organizationId": "333tydefda8256b93f753yh6",
"_creatorId": "63123ee5d9af70da9f6a2e4",
"deleted": false,
"createdAt": "2023-10-21T13:34:48.130Z",
"updatedAt": "2023-10-21T13:35:18.994Z",
"__v": 0,
"id": "7u83d3123t3a9e261ba9934r8"
}
}
Authorizations
Authorization
string
headerrequiredAPI key authentication. Allowed headers-- "Authorization: ApiKey <api_key>".
Path Parameters
workflowId
string
requiredResponse
200 - application/json
data
object
data._id
string
data.name
string
requireddata.description
string
requireddata.active
boolean
requireddata.draft
boolean
requireddata.preferenceSettings
object
requireddata.preferenceSettings.email
boolean
data.preferenceSettings.sms
boolean
data.preferenceSettings.in_app
boolean
data.preferenceSettings.chat
boolean
data.preferenceSettings.push
boolean
data.critical
boolean
requireddata.tags
string[]
requireddata.steps
object[]
requireddata.steps._id
string
data.steps.uuid
string
data.steps.name
string
data.steps._templateId
string
data.steps.active
boolean
data.steps.shouldStopOnFail
boolean
data.steps.template
object
data.steps.filters
object[]
data.steps.filters.isNegated
boolean
requireddata.steps.filters.type
enum<string>
requiredAvailable options:
BOOLEAN, TEXT, DATE, NUMBER, STATEMENT, LIST, MULTI_LIST, GROUP data.steps.filters.value
enum<string>
requiredAvailable options:
AND, OR data.steps.filters.children
object[]
requireddata.steps.filters.children.field
string
requireddata.steps.filters.children.value
string
requireddata.steps.filters.children.operator
enum<string>
requiredAvailable 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.on
enum<string>
requiredAvailable options:
subscriber, payload data.steps._parentId
object
data.steps.metadata
object
data.steps.metadata.amount
number
data.steps.metadata.unit
enum<string>
Available options:
seconds, minutes, hours, days, weeks, months data.steps.metadata.digestKey
string
data.steps.metadata.type
enum<string>
requiredAvailable options:
regular, backoff 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.updateMode
boolean
data.steps.replyCallback
object
data.steps.variants
object
data.steps.variants._id
string
data.steps.variants.uuid
string
data.steps.variants.name
string
data.steps.variants._templateId
string
data.steps.variants.active
boolean
data.steps.variants.shouldStopOnFail
boolean
data.steps.variants.template
object
data.steps.variants.filters
object[]
data.steps.variants.filters.isNegated
boolean
requireddata.steps.variants.filters.type
enum<string>
requiredAvailable options:
BOOLEAN, TEXT, DATE, NUMBER, STATEMENT, LIST, MULTI_LIST, GROUP data.steps.variants.filters.value
enum<string>
requiredAvailable options:
AND, OR data.steps.variants.filters.children
object[]
requireddata.steps.variants.filters.children.field
string
requireddata.steps.variants.filters.children.value
string
requireddata.steps.variants.filters.children.operator
enum<string>
requiredAvailable 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.variants.filters.children.on
enum<string>
requiredAvailable options:
subscriber, payload data.steps.variants._parentId
object
data.steps.variants.metadata
object
data.steps.variants.metadata.amount
number
data.steps.variants.metadata.unit
enum<string>
Available options:
seconds, minutes, hours, days, weeks, months data.steps.variants.metadata.digestKey
string
data.steps.variants.metadata.type
enum<string>
requiredAvailable options:
regular, backoff 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.updateMode
boolean
data.steps.variants.replyCallback
object
data._organizationId
string
requireddata._creatorId
string
requireddata._environmentId
string
requireddata.triggers
object[]
requireddata.triggers.type
enum<string>
requiredAvailable options:
event data.triggers.identifier
string
requireddata.triggers.variables
object[]
requireddata.triggers.variables.name
string
requireddata.triggers.subscriberVariables
object[]
data.triggers.subscriberVariables.name
string
requireddata._notificationGroupId
string
requireddata._parentId
string
data.deleted
boolean
requireddata.deletedAt
string
requireddata.deletedBy
string
requireddata.notificationGroup
object
data.notificationGroup._id
string
data.notificationGroup.name
string
requireddata.notificationGroup._environmentId
string
requireddata.notificationGroup._organizationId
string
requireddata.notificationGroup._parentId
string
data.data
object
data.workflowIntegrationStatus
object
Was this page helpful?
curl --request GET \
--url https://api.novu.co/v1/workflows/{workflowId} \
--header 'Authorization: <authorization>'
{
"data": {
"preferenceSettings": {
"email": true,
"sms": true,
"in_app": true,
"chat": true,
"push": true
},
"_id": "7u83d3123t3a9e261ba9934r8",
"name": "chat with Discord",
"active": true,
"draft": false,
"critical": true,
"isBlueprint": false,
"_notificationGroupId": "641eddefda8256b93f750e0b",
"tags": [],
"triggers": [
{
"type": "event",
"identifier": "chat-with-discord",
"variables": [
{
"name": "chatMsg",
"type": "String",
"_id": "7u83d3123t3a9e261ba9934r8",
"id": "7u83d3123t3a9e261ba9934r8"
}
],
"reservedVariables": [],
"subscriberVariables": [],
"_id": "7u83d3123t3a9e261ba9934r8",
"id": "7u83d3123t3a9e261ba9934r8"
}
],
"steps": [
{
"metadata": {
"timed": {
"weekDays": [],
"monthDays": []
}
},
"active": true,
"shouldStopOnFail": false,
"uuid": "9799f1c9-0de2-4252-8921-01840a71a741",
"name": "Chat",
"filters": [
{
"children": [],
"_id": "7u83d3123t3a9e261ba99376e",
"id": "7u83d3123t3a9e261ba993999"
}
],
"_templateId": "6533d389306c4d8cf7853557",
"_parentId": null,
"_id": "99u3d3123t3a9e261ba993r45",
"id": "90uid3123t3a9e261ba9978yu",
"template": {
"_id": "r567d3123t3a9e261ba9990as",
"type": "chat",
"active": true,
"subject": "",
"variables": [
{
"name": "chatMsg",
"type": "String",
"required": false,
"_id": "2383d3123t3a9e261ba997878",
"id": "8711d389306c4d8cf7859090"
}
],
"content": "{{chatMsg}}",
"contentType": "editor",
"_environmentId": "234edtyuda8256b93f7567f90",
"_organizationId": "333tydefda8256b93f753yh6",
"_creatorId": "63123ee5d9af70da9f6a2e4",
"_feedId": null,
"_layoutId": null,
"deleted": false,
"createdAt": "2023-10-21T13:35:05.825Z",
"updatedAt": "2023-10-21T13:35:18.156Z",
"__v": 0,
"id": "7u83d3123t3a9e261ba9934r8"
}
}
],
"_environmentId": "234edtyuda8256b93f7567f90",
"_organizationId": "333tydefda8256b93f753yh6",
"_creatorId": "63123ee5d9af70da9f6a2e4",
"deleted": false,
"createdAt": "2023-10-21T13:34:48.130Z",
"updatedAt": "2023-10-21T13:35:18.994Z",
"__v": 0,
"id": "7u83d3123t3a9e261ba9934r8"
}
}