riverflow docs

Real-Time Streams

This page is a step by step guide to create a real-time data stream in Riverflow.
The step 0 of a stream configuration is to give your stream a name at the top of the page by clicking on 'Unknown stream' and typing a name for your stream.
Step 1: Find the event you want to stream
A stream starts with the selection of an event. Riverflow reads events from the main EVM blockchains, you can find the list of supported blockchains here. There are 2 types of events available in Riverflow: pre-built events and custom events. Click here to know more about event types.
Pre-built event
  1. 1.
    Click on 'select event'
  2. 2.
    In the list, select the event you want to stream from the list of pre-built events
  3. 3.
    Choose the smart contracts on which you want to collect these events. There are 3 methods to choose smart contracts:
  • Find smart contracts manually in the search bar
  • Upload a CSV list of smart contracts
  • Select "All Smart contracts" and stream data from every relevant ERC for the selected event
Custom events
  1. 1.
    Click on 'select event'
  2. 2.
    in the drawer, choose "custom event"
  3. 3.
    In the search bar, search for the specific smart contract you would like to listen to, then select it
  4. 4.
    The available events for this smart contract will appear, select the relevant event that you want to stream
Apply filters to your event
You can apply filters to the selected event. There are 2 types of filters:
  1. 1.
    Property filters: filters on the properties of the event selected
  2. 2.
    Audience filters: apply a restricted audience to the event selected. There are 3 ways to apply an audience filter:
    1. 1.
      Upload a CSV file containing your audience, this should contain only "wallets" > Validate
    2. 2.
      Select an audience based on token holders. Click on "Audience from Token holders" > Search for a token to create your audience > Validate
    3. 3.
      Sync with a data source (Coming soon)
If no filter is applied, Riverflow will stream any event selected to you destination. Discover more about filters here.
Step 2: Select the destination where your event should be sent
Once you have chosen the event to stream and applied filters, select and setup the destination where this data should flow.
  1. 1.
    Go the the 'Destination' section > click on 'Add destination'
  2. 2.
    Select a destination from the list of supported destinations (you will find the list of currently supported destinations below)
  3. 3.
    Setup your destination. Depending on the chosen destination, different types of information can be asked, go to the page dedicated to your chosen destination to find out more.
Currently supported destinations:
Step 3: Map the selected event with your destination
Mapping is a critical part of your stream configuration. This is where you will align the blockchain event properties taxonomy with your destination taxonomy. You will also be able to enrich these properties by adding custom properties based on functions.
  1. 1.
    A list of 'Event properties' and 'Common properties' will appear, you can select or unselect properties as you like
  2. 2.
    The 'blockchain event name' section reflects the name of your event properties as they are written on the blockchain, the 'Destination event name' section reflects how this property should be named in your destination
Be careful, some destinations require spectific properties and properties name (For example, a CRM or an Analytics tool will require a user ID, read the documentation related to your chosen destination)
  1. 3.
    Add custom properties > You can chose to add custom properties by adding calculation and functions based on different data sources. Read the Custom event property page to find out more about custom event properties.
Step 4: Activate your stream
Once you have configured your stream, click on 'Preview' at the top of the page. You will then land on your preview page for your stream.
In the main section you will see the data flow, these is a preview of your stream. If you are satisfied with this preview, click on 'Activate' and start sending this data to your destination. Congrats! You have a created a stream with Riverflow!