These docs are for v1.7. Click to read the latest docs for v2.1.

Events & Retries

Events & Filters

Event names & filters

Event nameWebhook event nameFilterDefinition
Any events-All types of events are involved.
Any transferssmartAssetContract.TransferAll types of transfers are involved, from the NFT minting to end-user transfers.
Payload example.
NFT createdsmartAssetContract.TransferpreviousOwner
is
0x000000000[…]
When an NFT is created there is a first transfer from 0x0000to the issuer address.
Payload example.
NFT hydratedsmartAssetContract.HydratedAn NFT has been hydrated.
Payload example.
Brand transfersmartAssetContract.TransferpreviousOwner
is
nmpAddress
When a transfer occurred from the NFT Management Platform wallet to another wallet.
This event does not include an NFT mint.
Payload example.
Brand and customer transferssmartAssetContract.TransferInvolves the first brand to end-user transfer and other later transfers.
Payload example.
NFT updatesnmp.nftChangesAn NFT has been updated.
Payload example.
Message sentmessageContract.MessageSentA message has been sent.
Payload example.
Message readmessageContract.MessageReadA message has been read.
Payload example.
Wallet profilewalletProfileWhen wallet data is pushed.
Payload example.

Event Properties

Event PropertiesTypeDefinition
datan/aPackaged event
nameStringEvents are named with contractname.eventName. For example Transfer can be a transfer from ariaSmartContract or smartAssetContract
tokenIdStringRelevant tokenId, also known as certificateId
blocknumberIntegerBlock number when the event occurred
chainIdIntegerchainId where the event occurred. example: 77, 99, 1…
networkStringNetwork where the event occurred. Example: mainnet, testnet, polygon…
issuerAddressThe issuer of the relevant NFT
senderAddressIf the message event, the sender of the message
messageIdStringIf the event is message-related, messageId of the message
ownerAddressThe current owner of the relevant NFT
previousOwnerAddressIf the transfer event of the NFT, the previous owner of the NFT
signaturen/aSignature of data by a private key. It allows the webhook receiver to be sure that the event was sent by us

messageRead payload example:

{
  "data": {
    "name": "messageContract.MessageRead",
    "tokenId": "474476117",
    "chainId": 77,
    "network": "testnet",
    "blocknumber": 28661758,
    "raw": {
      "address": "0xadD562C6c8D8755E0FaB1c12705831E759b77D00",
      "blockHash": "0x47be5cc4a749ba9a3fd02847278fa6e0abce374deaba2f4ad5f2815549b15c92",
      "blockNumber": 28661758,
      "logIndex": 2,
      "removed": false,
      "transactionHash": "0xf10f00f7a738f3e69138491a09d69ff276b1134bcd07d5ecb0b1e7a45b2aab81",
      "transactionIndex": 1,
      "transactionLogIndex": "0x0",
      "id": "log_d864f39c",
      "returnValues": {
        "0": "0x5eFec7CBC5828099e51B63e79bD4A6bEF13B5545",
        "1": "0x57F5111A7e997a7Ba63CC8976C92decbd86C1B08",
        "2": "141088179",
        "_receiver": "0x5eFec7CBC5828099e51B63e79bD4A6bEF13B5545",
        "_sender": "0x57F5111A7e997a7Ba63CC8976C92decbd86C1B08",
        "_messageId": "141088179"
      },
      "event": "MessageRead",
      "signature": "0xd487ed2a9eb4497b51998ff0d7ac42a89f5d3a5039b9a7d6ebf64be4be1829b8",
      "raw": {
        "data": "0x",
        "topics": [
          "0xd487ed2a9eb4497b51998ff0d7ac42a89f5d3a5039b9a7d6ebf64be4be1829b8",
          "0x0000000000000000000000005efec7cbc5828099e51b63e79bd4a6bef13b5545",
          "0x00000000000000000000000057f5111a7e997a7ba63cc8976c92decbd86c1b08",
          "0x000000000000000000000000000000000000000000000000000000000868d5b3"
        ]
      }
    },
    "issuer": "0x57F5111A7e997a7Ba63CC8976C92decbd86C1B08",
    "owner": "0x5eFec7CBC5828099e51B63e79bD4A6bEF13B5545",
    "sender": "0x57F5111A7e997a7Ba63CC8976C92decbd86C1B08",
    "messageId": "141088179"
  },
  "signature": "3044022064b1baee2bacf68e5177388fb7be03a0ceace4b61d2c84ba6f50d39459a8ce71022024e7af87e5bf0dae5fbf0df938fc57caca3e54f9269cc80f372d846b6dc9ac76"
}

Retries & Request Methods

  • Automatic retries: each 1h up to 5 times
  • Request timeout: 1 minute
  • Request protocol: HTTPS and/or HTTP
  • Request method: POST