Explore the standardized unified format for events across various protocols and networks.
Events are sent using the UNIFIED_V1
format to all supported protocols and networks. This section will provide an overview of each supported event type that uses the format.
Note:
The
UNIFIED_V1
format is currently still in development. Some fields might still be subject to change.
Info:
To get a list of supported protocols, networks, and their supported events, please refer to this page.
Standardized Envelope
All events produced by Event Streaming will follow a standardized envelope in the UNIFIED_V1
format. Below is an example of the structure:
{
"protocol":"bitcoin",
"network":"mainnet",
"event_type":"<event_type>",
"chain_id":"<namespace>:<network-identifier>",
"data": {}
}
The table below shows the schema breakdown:
Field | Type | Description |
---|---|---|
protocol | string | The blockchain protocol. |
network | string | The blockchain network. |
event_type | string | The name/type of the event. Based on the Event Type: - unified_block - unified_reorg Based on Address: - unified_confirmed_tx_log - unified_confirmed_balance - unified_confirmed_tx - unified_confirmed_tx_trace - unified_staking_reward - unified_staking_status |
chain_id | string | The blockchain network where the event occurred. It combines a namespace with a network-specific identifier to uniquely reference the network. For example, eip155:1 for Ethereum and bip122:<blockhash> for Bitcoin. |
data | object | The event payload is determined by which event_type is shown. |
raw | object | Raw payload (not included by default) |
Other Templates
By default, rules use the UNIFIED_V1
template, a predefined option that applies the unified format. However, there are two other predefined templates you can use:
- UNIFIED_V1_RAW: This template is the same as
UNIFIED_V1
but additionally adds araw
key to the envelope. - ALL_DATA: This template does not apply any formatting or modifications and will return messages in their original form.
See the Advanced templating page for more details.
How to use it?
To use either of these templates, specify the predefined template in the template
parameter when creating or updating rules.
👋 Need Help?
Contact us through email or our support page for any issues, bugs, or assistance you may need.