Notification
Get notification
- API Overview
- API Rate Limiting
Events
Subscribers
Topics
Notification
Workflows
Workflow Overrides
Workflow groups
Integrations
Layouts
Environments
Changes
Execution Details
Feeds
Tenants
Organizations
Messages
Notification
Get notification
GET
/
v1
/
notifications
/
{notificationId}
Authorization
string
*
Authorization
Required
string
API key authentication. Allowed headers-- "Authorization: ApiKey <api_key>".
notificationId
string
*
notificationId
Required
string
import co.novu.Novu
import co.novu.extensions.notification
fun main() {
val novu = Novu(apiKey = "<NOVU_SECRET_KEY>")
val notification = novu.notification("<NOTIFICATION_ID>")
println(notification)
}
{
"data": {
"_id": "<string>",
"_environmentId": "<string>",
"_organizationId": "<string>",
"transactionId": "<string>",
"createdAt": "<string>",
"channels": "in_app",
"subscriber": {
"firstName": "<string>",
"_id": "<string>",
"lastName": "<string>",
"email": "<string>",
"phone": "<string>"
},
"template": {
"_id": "<string>",
"name": "<string>",
"triggers": [
"<string>"
]
},
"jobs": [
"<string>"
]
}
}
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_SECRET_KEY>")
val notification = novu.notification("<NOTIFICATION_ID>")
println(notification)
}
Authorizations
Authorization
string
headerrequiredAPI key authentication. Allowed headers-- "Authorization: ApiKey <api_key>".
Path Parameters
notificationId
string
requiredResponse
200 - application/json
data
object
data._id
string
data._environmentId
string
requireddata._organizationId
string
requireddata.transactionId
string
requireddata.createdAt
string
data.channels
enum<string>
Available options:
in_app
, email
, sms
, chat
, push
, digest
, trigger
, delay
, custom
data.subscriber
object
data.subscriber.firstName
string
data.subscriber._id
string
requireddata.subscriber.lastName
string
data.subscriber.email
string
data.subscriber.phone
string
data.template
object
data.template._id
string
data.template.name
string
requireddata.template.triggers
string[]
requireddata.jobs
string[]
Was this page helpful?
import co.novu.Novu
import co.novu.extensions.notification
fun main() {
val novu = Novu(apiKey = "<NOVU_SECRET_KEY>")
val notification = novu.notification("<NOTIFICATION_ID>")
println(notification)
}
{
"data": {
"_id": "<string>",
"_environmentId": "<string>",
"_organizationId": "<string>",
"transactionId": "<string>",
"createdAt": "<string>",
"channels": "in_app",
"subscriber": {
"firstName": "<string>",
"_id": "<string>",
"lastName": "<string>",
"email": "<string>",
"phone": "<string>"
},
"template": {
"_id": "<string>",
"name": "<string>",
"triggers": [
"<string>"
]
},
"jobs": [
"<string>"
]
}
}