- API Reference
- Discord Support
- 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 preference
- 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
- GETFilter topics
- POSTTopic creation
- POSTSubscribers addition
- GETCheck topic subscriber
- POSTSubscribers removal
- GETGet topic
- DELDelete topic
- PATCHRename a topic
- GETGet notifications
- GETGet notification statistics
- GETGet notification graph statistics
- GETGet notification
- GETGet workflows
- POSTCreate workflow
- GETGet workflow
- PUTUpdate workflow
- DELDelete workflow
- PUTUpdate workflow status
- POSTCreate workflow overrides
- GETGet workflow overrides
- GETGet workflow override
- GETGet workflow override by id
- PUTUpdate workflow override by id
- PUTUpdate workflow override
- DELDelete workflow override
- GETGet workflow groups
- POSTCreate workflow group
- GETGet workflow group
- DELDelete workflow group
- PATCHUpdate workflow group
- GETGet integrations
- POSTCreate integration
- GETGet active integrations
- GETGet webhook support status for provider
- PUTUpdate integration
- DELDelete integration
- POSTSet integration as primary
- GETFilter layouts
- POSTLayout creation
- GETGet layout
- DELDelete layout
- PATCHUpdate a layout
- POSTSet default layout
- GETGet execution details
Subscribers
Topics
Notification
Workflows
Workflow Overrides
Workflow groups
Integrations
Layouts
Execution Details
Workflow Overrides
Get workflow overrides
GET
/
v1
/
workflow-overrides
Authorization
string
*
Authorization
Required
string
page
number
page
number
limit
number
limit
number
curl --request GET \
--url https://api.novu.co/v1/workflow-overrides
{
"data": {
"hasMore": true,
"data": [
{
"_id": "<string>",
"_organizationId": "<string>",
"_environmentId": "<string>",
"_workflowId": "<string>",
"_tenantId": "<string>",
"active": true,
"preferenceSettings": {
"email": true,
"sms": true,
"in_app": true,
"chat": true,
"push": true
},
"deleted": true,
"deletedAt": "<string>",
"deletedBy": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>"
}
],
"pageSize": 123,
"page": 123
}
}
Enter your API key in the Authorization
field like the example shown below:
E.g ApiKey 18d2e625f05d80e
Query Parameters
page
number
limit
number
default: 10Response
200 - application/json
data
object
data.hasMore
boolean
requireddata.data
object[]
requireddata.data._id
string
requireddata.data._organizationId
string
requireddata.data._environmentId
string
requireddata.data._workflowId
string
requireddata.data._tenantId
string
requireddata.data.active
boolean
requireddata.data.preferenceSettings
object
requireddata.data.preferenceSettings.email
boolean
data.data.preferenceSettings.sms
boolean
data.data.preferenceSettings.in_app
boolean
data.data.preferenceSettings.chat
boolean
data.data.preferenceSettings.push
boolean
data.data.deleted
boolean
requireddata.data.deletedAt
string
data.data.deletedBy
string
data.data.createdAt
string
requireddata.data.updatedAt
string
requireddata.pageSize
number
requireddata.page
number
requiredWas this page helpful?
curl --request GET \
--url https://api.novu.co/v1/workflow-overrides
{
"data": {
"hasMore": true,
"data": [
{
"_id": "<string>",
"_organizationId": "<string>",
"_environmentId": "<string>",
"_workflowId": "<string>",
"_tenantId": "<string>",
"active": true,
"preferenceSettings": {
"email": true,
"sms": true,
"in_app": true,
"chat": true,
"push": true
},
"deleted": true,
"deletedAt": "<string>",
"deletedBy": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>"
}
],
"pageSize": 123,
"page": 123
}
}