Skip to main content

🔔 Notification

This endpoint is used to create a new notification for a user in our platform.

All the notification types have the same general body structure

POST /notification


Body Structure

walletAddressmandatoryStringUser's wallet address
signBytesResultmandatoryStringUser's signature of the bytes generated by Hermes Protocol
originalBytesmandatoryStringBytes generated by Hermes Protocol
notificationTypeIdmandatoryStringId of the notification type
chainIdmandatoryStringId of the blockchain
categoryIdmandatoryStringId of the category
projectIdmandatoryStringId of the project
notificationParamsmandatoryObjectParameters of the notification

The bytes generated by us are used to verify the signature of the user. If the signature is valid, the notification will be created. If you didn't generate the bytes, see here how to do it.

Example Request

"walletAddress": "terra194wmtg0...ja4",
"signBytesResult": {
"recid": 0,
"signature": {
"0": 227,
"..." : "...",
"63": 186
"public_key": "{\"@type\":\"/cosmos.crypto.secp256k1.PubKey\",\"key\":\"xxx\"}"
"originalBytes": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"chainId": "zb1_002",
"categoryId": "zb3_0008",
"projectId": "zb2_0034",
"notificationTypeId": "002_0029",
"notificationParams": {
... specific for each notification type

See here a list of supported notifications, their parameters and their types.


Status Codes

200Notification successfully created
202Notification successfully created but disable
400Invalid request

Example Response

"walletAddress": "terra194wmtg0...ja4",
"bytes": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"status": 200