Notification
Get notification
API Reference
Subscribers
- GETGet subscribers
- POSTCreate subscriber
- POSTBulk create subscribers
- GETGet subscriber
- PUTUpsert 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
Notification
Get notification
GET
/
v1
/
notifications
/
{notificationId}
import co.novu.Novu
import co.novu.extensions.notification
fun main() {
val novu = Novu(apiKey = "<NOVU_API_KEY>")
val notification = novu.notification("<NOTIFICATION_ID>")
println(notification)
}
{
"data": {
"_id": "<string>",
"_environmentId": "<string>",
"_organizationId": "<string>",
"_subscriberId": "<string>",
"transactionId": "<string>",
"_templateId": "<string>",
"_digestedNotificationId": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>",
"channels": [
"in_app"
],
"subscriber": {
"firstName": "<string>",
"subscriberId": "<string>",
"_id": "<string>",
"lastName": "<string>",
"email": "<string>",
"phone": "<string>"
},
"template": {
"_id": "<string>",
"name": "<string>",
"origin": "novu-cloud",
"triggers": [
{
"type": "event",
"identifier": "<string>",
"variables": [
{
"name": "<string>"
}
],
"subscriberVariables": [
{
"name": "<string>"
}
]
}
]
},
"jobs": [
{
"_id": "<string>",
"type": "in_app",
"digest": {
"digestKey": "<string>",
"amount": 123,
"unit": "seconds",
"type": "regular",
"events": [
{}
],
"backoff": true,
"backoffAmount": 123,
"backoffUnit": "seconds",
"updateMode": true,
"timed": {
"atTime": "<string>",
"weekDays": [
"monday"
],
"monthDays": [
123
],
"ordinal": "1",
"ordinalValue": "day",
"monthlyType": "each",
"cronExpression": "<string>"
}
},
"executionDetails": [
{
"_id": "<string>",
"createdAt": "<string>",
"status": "Success",
"detail": "<string>",
"isRetry": true,
"isTest": true,
"providerId": "emailjs",
"raw": "<string>",
"source": "Credentials"
}
],
"step": {
"_id": "<string>",
"active": true,
"replyCallback": {},
"controlVariables": {},
"metadata": {},
"issues": {},
"filters": [
{
"isNegated": true,
"type": "BOOLEAN",
"value": "AND",
"children": [
{
"field": "<string>",
"value": "<string>",
"operator": "LARGER",
"on": "subscriber"
}
]
}
],
"template": {},
"variants": [
{}
],
"_templateId": "<string>",
"name": "<string>",
"_parentId": "<string>"
},
"overrides": {
"workflowId": "some_wf_id",
"stepId": "some_wf_id"
},
"payload": {},
"providerId": "emailjs",
"status": "<string>",
"updatedAt": "<string>"
}
],
"payload": {},
"tags": [
"<string>"
],
"controls": {},
"to": {}
}
}
Enter your API key in the Authorization
field like the example shown below:
E.g ApiKey 18d2e625f05d80e
import co.novu.Novu
import co.novu.extensions.notification
fun main() {
val novu = Novu(apiKey = "<NOVU_API_KEY>")
val notification = novu.notification("<NOTIFICATION_ID>")
println(notification)
}
Authorizations
API key authentication. Allowed headers-- "Authorization: ApiKey <api_key>".
Path Parameters
Response
200
application/json
OK
The response is of type object
.
Was this page helpful?
import co.novu.Novu
import co.novu.extensions.notification
fun main() {
val novu = Novu(apiKey = "<NOVU_API_KEY>")
val notification = novu.notification("<NOTIFICATION_ID>")
println(notification)
}
{
"data": {
"_id": "<string>",
"_environmentId": "<string>",
"_organizationId": "<string>",
"_subscriberId": "<string>",
"transactionId": "<string>",
"_templateId": "<string>",
"_digestedNotificationId": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>",
"channels": [
"in_app"
],
"subscriber": {
"firstName": "<string>",
"subscriberId": "<string>",
"_id": "<string>",
"lastName": "<string>",
"email": "<string>",
"phone": "<string>"
},
"template": {
"_id": "<string>",
"name": "<string>",
"origin": "novu-cloud",
"triggers": [
{
"type": "event",
"identifier": "<string>",
"variables": [
{
"name": "<string>"
}
],
"subscriberVariables": [
{
"name": "<string>"
}
]
}
]
},
"jobs": [
{
"_id": "<string>",
"type": "in_app",
"digest": {
"digestKey": "<string>",
"amount": 123,
"unit": "seconds",
"type": "regular",
"events": [
{}
],
"backoff": true,
"backoffAmount": 123,
"backoffUnit": "seconds",
"updateMode": true,
"timed": {
"atTime": "<string>",
"weekDays": [
"monday"
],
"monthDays": [
123
],
"ordinal": "1",
"ordinalValue": "day",
"monthlyType": "each",
"cronExpression": "<string>"
}
},
"executionDetails": [
{
"_id": "<string>",
"createdAt": "<string>",
"status": "Success",
"detail": "<string>",
"isRetry": true,
"isTest": true,
"providerId": "emailjs",
"raw": "<string>",
"source": "Credentials"
}
],
"step": {
"_id": "<string>",
"active": true,
"replyCallback": {},
"controlVariables": {},
"metadata": {},
"issues": {},
"filters": [
{
"isNegated": true,
"type": "BOOLEAN",
"value": "AND",
"children": [
{
"field": "<string>",
"value": "<string>",
"operator": "LARGER",
"on": "subscriber"
}
]
}
],
"template": {},
"variants": [
{}
],
"_templateId": "<string>",
"name": "<string>",
"_parentId": "<string>"
},
"overrides": {
"workflowId": "some_wf_id",
"stepId": "some_wf_id"
},
"payload": {},
"providerId": "emailjs",
"status": "<string>",
"updatedAt": "<string>"
}
],
"payload": {},
"tags": [
"<string>"
],
"controls": {},
"to": {}
}
}