Address Webhooks

⚠️ Beta Feature: Webhooks are currently in beta. While fully functional, some features are still being refined.

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

Field	Required	Description
Address	Yes	The Sui address to monitor (sender or recipient)
Webhook URL	Yes	Your HTTPS endpoint

Example Payloads

Sender Activity

When the monitored address sends a transaction:

{
  "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:

{
  "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

Field	Type	Description
address	string	The monitored address
activityType	sender | object_received	Whether address sent a tx or received an object
txDigest	string	Transaction digest
checkpoint	number	Checkpoint sequence number
timestamp	number	Unix timestamp in milliseconds
objectId	string | null	Object ID (only for object_received activity)
objectType	string | null	Move 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

• Webhook Setup Guide - Endpoint requirements and signature verification
• Event Webhooks - Monitor smart contract events
• Coin Webhooks - Track token balance changes
• Object Webhooks - Watch object mutations