What is Subscription?

Subscriptions are monitoring configurations you create for specific blockchain activities, such as tracking an address. Simply provide the address you want to monitor, the chain, and the webhook URL — and you’ll automatically receive notifications or alerts whenever a relevant transaction occurs.

// REQUEST BODY
{
  "type": "ADDRESS_EVENT",
  "attr": {
    "chain": "arb-one-mainnet",
    "address": "0x50747Ee6ad995E8234E251A35b90C0aFcBEe4d33",
    "url": "https://your.com/webhook-handler"
  }
}

// Response
id

Get Started now and Create a subscription 🚀

What are Notifications?

Notifications are events we send you through channels like webhooks. Eg :

A notification when a transaction happens on vitalik.eth
A notification when your wallet receives USDT

// Sample Webhook - Custom Template.
{
	"from": "0x690B9A9E9aa1C9dB991C7721a92d351Db4FaC990",
  "to": "0xF64E82131BE01618487Da5142fc9d289cbb60E9d",
  "value": "0.001",
  "asset": "ETH",
  "blockNumber": 2913059,
  "txId": "0x062d236ccc044f68194a04008e98c3823271dc26160a4db9ae9303f9ecfc7bf6",
  "type": "native",
  "chain": "ethereum-mainnet",
  "subscriptionType": "ADDRESS_EVENT"
}

What are Templates?

Templates allow you to define what fields or response entities you would like to have in the webhook, You can use pre created templates or create one and you would be given a template id, which can be passed during subscription creation.

// Custom Template - Request Body
{
  "format": "json",
  "keys": {
    "whoSent": "from",
    "whomTo": "to",
    "howMuch": "value",
    "what": "currency"
  }
}

// Response 
templateID

You can now use this template in your subscription creation to get exactly the specified keys in the response.

Learn more about using Templates here.