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)
}

{
  "_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": [
      {
        "type": "event",
        "identifier": "<string>",
        "variables": [
          {
            "name": "<string>"
          }
        ],
        "subscriberVariables": [
          {
            "name": "<string>"
          }
        ]
      }
    ]
  },
  "jobs": [
    {
      "_id": "<string>",
      "type": "<string>",
      "digest": {},
      "executionDetails": [
        {
          "_id": "<string>",
          "_jobId": "<string>",
          "status": "Success",
          "detail": "<string>",
          "isRetry": true,
          "isTest": true,
          "providerId": {},
          "raw": "<string>",
          "source": "Credentials"
        }
      ],
      "step": {
        "_id": "<string>",
        "active": true,
        "filters": {
          "isNegated": true,
          "type": "BOOLEAN",
          "value": "AND",
          "children": [
            {
              "field": "<string>",
              "value": "<string>",
              "operator": "LARGER",
              "on": "subscriber"
            }
          ]
        },
        "template": {}
      },
      "payload": {},
      "providerId": {},
      "status": "<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_API_KEY>")
    val notification = novu.notification("<NOTIFICATION_ID>")
    println(notification)
}

Authorizations

​
Authorization
string
header
required

API key authentication. Allowed headers-- "Authorization: ApiKey <api_key>".

Path Parameters

​
notificationId
string
required

Response

200
application/json
Ok
​
_environmentId
string
required
​
_organizationId
string
required
​
transactionId
string
required
​
_id
string
​
createdAt
string
​
channels
enum<string>
Available options:
in_app,
email,
sms,
chat,
push,
digest,
trigger,
delay,
custom
​
subscriber
object
​
template
object
​
jobs
object[]

Was this page helpful?