Skip to main content

webhook-overview


Supported Event

EventType is the event value you configure when using Webhooks. The payload you receive depends on the EventType. Supported EventTypes are listed below.

Event Type

Description

ADDRESS_ACTIVITY

Monitors activity of accounts in a specified address list. Notifications are sent when those accounts appear as sender (from) or receiver (to) in transactions—e.g. native transfers, token transfers (ERC20), or NFT transfers (ERC721, ERC1155). Use this to track activity across many addresses in real time.

MINED_TRANSACTION

Sends the transaction receipt when a transaction from a specified address is mined and confirmed on the network. You receive notifications for both successful and failed transactions, so you can track final status in real time.

SUCCESSFUL_TRANSACTION

Notifies when a transaction from a specified address is successfully executed and confirmed. Use it to confirm that your transaction completed as intended.

FAILED_TRANSACTION

Notifies when a transaction from a specified address fails (rejected by the network or reverted). Use it to quickly identify causes of failure (e.g. out of gas, contract conditions) and take action.

TOKEN_TRANSFER

Notifies on token (ERC20) or NFT (ERC721, ERC1155) transfers. You can filter by contract address and, for ERC721/ERC1155, by token ID.

BELOW_THRESHOLD_BALANCE

Notifies when an account’s balance falls below a threshold you set. Useful for treasury and asset monitoring so you can top up or take action in time.

BLOCK_PERIOD

Notifies at a chosen block interval (e.g. every block, every N blocks). Provides block data after blocks are confirmed for stable, finalized data.

BLOCK_LIST_CALLER

Notifies when an address on a block list sends tokens to a target address. Use it to monitor predefined blocklisted addresses and detect unwanted or suspicious transfers.

ALLOW_LIST_CALLER

Notifies when an address on an allow list sends tokens to a target address. Use it to track trusted senders and confirm expected inflows.

LOG

Notifies when a transaction contains specified smart contract event logs. You can filter by one or more event signatures (e.g. ERC20 Transfer). Use it to track standard token transfers or custom contract events.

EVENT

You configure the API with an event type (eventType) and the account that emits it (eventAccountAddress). The API then sends notifications whenever events match those conditions. Use it to track specific events by including the relevant account in the API configuration.

TRANSACTION

You configure the API with an event type and the account that emits it. When that event type occurs, the API returns full transaction details for the transaction that included the event. You can see the full transaction, sender, receiver, amount, called functions, and related data, which is useful for system monitoring.