API Reference
Subscribers
- GETGet subscribers
- POSTCreate subscriber
- POSTBulk create subscribers
- GETGet subscriber
- PUTUpdate subscriber
- DELDelete subscriber
- PUTUpdate subscriber credentials
- DELDelete subscriber credentials by providerId
- PATCHUpdate subscriber online status
- GETGet subscriber preferences
- GETGet subscriber global preferences
- PATCHUpdate subscriber preference
- PATCHUpdate subscriber global preferences
- GETGet in-app notification feed for a particular subscriber
- GETGet the unseen in-app notifications count for subscribers feed
- POSTMark a subscriber feed message as seen
- POSTMarks all the subscriber messages as read, unread, seen or unseen. Optionally you can pass feed id (or array) to mark messages of a particular feed.
- POSTMark message action as seen
- GETHandle providers oauth redirect
- GETHandle chat oauth
Topics
Notification
Workflows
Workflow Overrides
Workflow groups
Integrations
Layouts
Execution Details
Organizations
Get workflow
curl --request GET \
--url https://api.novu.co/v1/workflows/{workflowIdOrIdentifier} \
--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/{workflowIdOrIdentifier} \
--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"
}
}
Was this page helpful?
curl --request GET \
--url https://api.novu.co/v1/workflows/{workflowIdOrIdentifier} \
--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"
}
}