Webhook events and payloads
The Webhooks service is in beta testing and is accessible to select community projects and Sky Mavis partners.
Overview
After you registered a webhook URL with Sky Mavis, we will issue an HTTP POST request to the specified URL every time an event occurs. The request's POST parameters contain JSON data relevant to the event that triggered the request. This page describes the webhook events and provides example JSON payloads for each event type.
| Event | Sent when | Network |
|---|---|---|
| Address activity | An address sends or receives a token. | Saigon testnet, Ronin mainnet |
| Token transfer | A contract address has new transactions. | Saigon testnet, Ronin mainnet |
| RON transfer | A RON transaction occurs. | Saigon testnet, Ronin mainnet |
Address activity
Address activity events are triggered when the address you specify sends or receives a token. You can specify up to five addresses.
Example payload:
{
"webhookId": "wh_2Xc2t8jhF1oLcypKk4E7t6ueMKH",
"eventId": "0e0cfaf48d87b40d5856c352d554afce",
"createdAt": "2023-11-08T08:07:16.097Z",
"type": "ADDRESS_ACTIVITY",
"event": {
"network": "RONIN_SAIGON_TESTNET",
"activities": [
{
"blockHash": "0x3e69b206304004f5b93456f562fee341a8ad6fe0468821a706a59bf84fb9787e",
"blockNumber": 21910244,
"blockTimeMillis": 1699430805000,
"category": "token",
"contractAddress": "0x3c4e17b9056272ce1b49f6900d8cfd6171a1869d",
"decimals": 18,
"erc721TokenId": "",
"fromAddress": "0x39fd40134e0d25fa34082d3b0fa9571c15897572",
"rawValue": "0x27e60d44813f80000",
"symbol": "AXS",
"toAddress": "0x271fe61bf3b771c87b803a5d0f522587249e0028",
"tokenStandard": "erc20",
"transactionHash": "0xcc202938e41e212304bbc488225a8aa38099f88dbda7cbf7cc375cecedeb5f55",
"value": 46
}
]
}
}
Token transfer
Token transfer events occur when the contract address that you specify has new transactions.
You can specify up to five contract addresses and for each address, filter events by the following:
- Transaction amount
- The from address
- The to address
Example payload:
{
"webhookId": "wh_2XswjDiGYhXpehhK6yQ9icoNzph",
"eventId": "3c35315df055c897f40c642123b64834",
"createdAt": "2023-11-08T08:14:43.304Z",
"type": "TOKEN_TRANSFER",
"event": {
"network": "RONIN_SAIGON_TESTNET",
"activities": [
{
"blockHash": "0xcc70a1cdab76b8681c044014ca8990733d3dd68986af5c41fd61bf8fb88f5b40",
"blockNumber": 21910393,
"blockTimeMillis": 1699431252000,
"contractAddress": "0x3c4e17b9056272ce1b49f6900d8cfd6171a1869d",
"decimals": 18,
"fromAddress": "0x39fd40134e0d25fa34082d3b0fa9571c15897572",
"symbol": "AXS",
"toAddress": "0xc6b752521efd912b3823606a9f9b414247f72959",
"tokenId": "",
"tokenStandard": "erc20",
"transactionHash": "0x5e859b014fdd5d4713a211c3b0b32d2ce95a91b22a44539a8e7e3422a64d4f61",
"value": 5,
"valueRaw": "0x4563918244f40000"
}
]
}
}
RON transfer
RON transfer events occur whenever a RON transaction takes place.
You can also filter RON transfer events by the following:
- Transaction amount
- The from address
- The to address
Example payload:
{
"webhookId": "wh_2Xc1kjXLGwL2sjqvyQDOptGPOMA",
"eventId": "e9fb309b01f9708965d6aeafa7369cec",
"createdAt": "2023-11-08T08:18:48.609Z",
"type": "RON_TRANSFER",
"event": {
"network": "RONIN_SAIGON_TESTNET",
"activities": [
{
"blockHash": "0x0c973d1e546a3f62e0575bf14eb99336ae76d366158e04afa6d6455974cc2dd0",
"blockNumber": 21910475,
"blockTimeMillis": 1699431498000,
"decimals": 18,
"fromAddress": "0x39fd40134e0d25fa34082d3b0fa9571c15897572",
"rawValue": "0x53444835ec580000",
"toAddress": "0xc6b752521efd912b3823606a9f9b414247f72959",
"transactionHash": "0xedd1750eb9b9736791c8ad4b4095d9515b189751bfc13b43ec83556393870fa6",
"transferMethod": "Transaction",
"value": 6
}
]
}
}