Skip to content

Address Webhooks ​

Monitor all transaction activity involving a specific Sui address.

Overview ​

Address webhooks notify you when a specific address sends transactions or receives objects. This is ideal for tracking wallet activity, monitoring treasury wallets, or building notification systems.

Configuration ​

FieldRequiredDescription
AddressYesThe Sui address to monitor (sender or recipient)
Webhook URLYesYour HTTPS endpoint

Example Payloads ​

Sender Activity ​

When the monitored address sends a transaction:

json
{
  "payloadVersion": 1,
  "payload": {
    "address": "0x1234abcd",
    "activityType": "sender",
    "txDigest": "Hx7Kj2mnop",
    "checkpoint": 12345680,
    "timestamp": 1703097650000,
    "objectId": null,
    "objectType": null
  }
}

Object Received ​

When the monitored address receives an object:

json
{
  "payloadVersion": 1,
  "payload": {
    "address": "0x1234abcd",
    "activityType": "object_received",
    "txDigest": "Hx7Kj2mnop",
    "checkpoint": 12345680,
    "timestamp": 1703097650000,
    "objectId": "0x5678efgh",
    "objectType": "0x2::coin::Coin<0x2::sui::SUI>"
  }
}

Payload Fields ​

FieldTypeDescription
addressstringThe monitored address
activityTypesender | object_receivedWhether address sent a tx or received an object
txDigeststringTransaction digest
checkpointnumberCheckpoint sequence number
timestampnumberUnix timestamp in milliseconds
objectIdstring | nullObject ID (only for object_received activity)
objectTypestring | nullMove type of object (only for object_received)

Use Cases ​

Portfolio Applications ​

  • Track wallet activity for portfolio dashboards
  • Show real-time transaction history
  • Calculate gas spending over time

Treasury Monitoring ​

  • Monitor team/treasury wallets for activity
  • Alert on unauthorized transactions
  • Track fund movements between wallets

User Notifications ​

  • Alert users of account activity
  • Push notifications for incoming tokens
  • Email notifications for outgoing transactions

Compliance & Audit ​

  • Create audit trails for regulated entities
  • Monitor specific addresses for compliance
  • Track wallet interactions for reporting

Best Practices ​

  1. Use specific addresses - Monitor only the addresses you need to reduce volume
  2. Handle both activity types - Your endpoint should handle both sender and object_received
  3. Track object types - Use objectType to filter for specific token types in your application

Next Steps ​

The full-stack Sui data layer.