Skip to main content

Detail Notification by ID

This API returns detailed information about a specific notification identified by ID, including its read status.

Endpoint Details

URL/v1/notifications/id
MethodGET
AuthorizationBearer Token

Request Headers

HeaderTypeDescription
Content-TypeStringMust be application/json

Request Path

To retrieve the details of a specific notification, use the following request format:

/v1/notifications/363bc3b6-74eb-40df-8c1c-04ec61e1dc7a

Path Parameter

ParameterTypeDescription
idUUIDUnique identifier of the notification

Response

Here is an example of a response when viewing data details:

Response
{
"id": "363bc3b6-74eb-40df-8c1c-04ec61e1dc7a",
"title": "Key rotation scheduled",
"activity": "Auto-rotation set for ring crypto/72859af3-e342-4440-b8d0-c98acd9ac3e1 every 1h0m0s",
"description": "Key rotation schedule created",
"category": 2,
"category_id": "b2c3d4e5-f6a7-4b5c-9d0e-1f2a3b4c5d6e",
"severity": 3,
"type": 2,
"channels": [
2,
1
],
"config_notification_id": "9a91d205-ca27-4b0f-b767-7cc3e411137c",
"read_at": "2026-07-21T15:41:07+07:00",
"read_by": "0a937c60-0ed4-4d06-870a-2e284b54287d",
"read_by_name": "Admin Aplikasi",
"created_at": "2026-07-21T15:32:49+07:00"
}

Field Descriptions

FieldTypeDescription
idUUIDUnique identifier of the notification
titleStringTitle of the notification
activityStringDetailed description of the activity that triggered the notification
descriptionStringShort description of the notification
categoryIntegerCategory code of the notification
category_idUUIDIdentifier of the notification category
severityIntegerSeverity code of the notification
typeIntegerType code of the notification
channelsArrayList of channel codes the notification was delivered through
config_notification_idUUIDIdentifier of the notification configuration that produced it
read_atStringTimestamp when the notification was read, in RFC 3339 format
read_byUUIDIdentifier of the user who read the notification
read_by_nameStringDisplay name of the user who read the notification
created_atStringCreation timestamp in RFC 3339 date-time format

info
  • A valid Bearer Token is required to access this endpoint.
  • The id path parameter must reference an existing notification.
  • The read_at, read_by, and read_by_name fields are only present once the notification has been read.
  • The category field uses the following codes:
    • 1 = Security & Access Control
    • 2 = Key Lifecycle
    • 3 = Backup & Recovery
    • 4 = System Health & Performance
    • 5 = Compliance & Audit Trail
    • 6 = User & Role Management
    • 7 = Network & Connectivity
    • 8 = Integration & API Activity
    • 9 = Operational & Maintenance
  • The severity field uses the following codes:
    • 1 = Critical
    • 2 = High
    • 3 = Medium
    • 4 = Low
  • The channels array uses the following codes:
    • 1 = Email
    • 2 = Dashboard
  • Timestamps are returned in RFC 3339 date-time format.