Skip to content

Webhooks

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

ℹ️ Available on All Plans: Webhooks are available on all plans including Free tier. See webhook limits by plan.

Overview

Inodra's webhook service delivers real-time notifications when activity occurs on the Sui blockchain. Instead of polling, we push HTTP POST requests to your endpoint when activity matches your criteria.

🚀 Ready to set up webhooks?

Create your free account and configure your first webhook in the dashboard.

Webhook Types

Choose the right webhook type for your use case:

TypeWhat It MonitorsExample Use CaseLearn More
EventsPackage event typesReact to DEX swaps, NFT mintsIncludes field filtering
AddressesWallet activityTrack treasury or user walletsSender & receiver activity
CoinsToken balance changesPayment confirmationsFilter by coin type
ObjectsObject mutationsWatch NFTs or AMM poolsTrack ownership changes

Key Features

  • Push delivery over HTTPS when activity matches your filters
  • Multiple filter types: Events, addresses, coins, and objects
  • Event field filtering: Filter events by specific field values (e.g., amount > 1000)
  • Signature verification via HMAC-SHA256 for security
  • Deduplication via X-Dedupe-Key header
  • Automatic retry with exponential backoff (up to 10 attempts over ~17 hours)
  • Delivery logs with full visibility into status and errors
  • Manual replay for webhooks (Business plan and above)
  • Dashboard UI for managing webhooks, viewing logs, and replaying deliveries

Quick Start

1. Set Up Your Endpoint

Create an HTTPS endpoint to receive webhooks:

javascript
app.post('/webhooks/sui', (req, res) => {
  console.log('Received webhook:', req.body)
  // Process the webhook...
  res.status(200).send('OK')
})

2. Register a Webhook

Add a webhook via the dashboard:

  1. Navigate to Webhooks
  2. Click Add Webhook
  3. Select the webhook type (Event, Address, Coin, or Object)
  4. Configure your filters and endpoint URL
  5. For event webhooks, optionally add field filters
  6. Save

3. Start Receiving Data

When matching activity occurs on-chain, you'll receive a POST request with the webhook payload.

Common Use Cases

DeFi Applications

  • DEX Trading: React to swap events above a certain amount using field filters
  • Lending Protocols: Monitor collateral and liquidation events
  • Yield Farming: Track rewards and stake changes

NFT Marketplaces

  • Mint Events: Notify users when new NFTs are created
  • Transfer Events: Update ownership records in real-time using object webhooks
  • Sale Events: Process marketplace transactions instantly

Gaming Applications

  • Item Transfers: Update game state when items move
  • Achievement Events: Trigger rewards and notifications
  • Battle Results: Process combat outcomes immediately

Portfolio Tracking

Next Steps

Released under the MIT License.