Events Unified Format

Events are sent using the UNIFIED_V1format 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:

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:

1. UNIFIED_V1_RAW: This template is the same as UNIFIED_V1 but additionally adds a raw key to the envelope.
2. 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.