Venice tries to be as clear and consistent as possible with the nomenclature used throughout the documentation and code base.
To that end, here’s a list of what our primitives are and examples of how you can think of them in use.
|An isolated Venice workspace with its own
End User’s and
|A developer using Venice to deliver great experiences! May belong to multiple
|A customer of yours gives you access to their
Resource as part of using your product.
|A product or service that your customers use (e.g. Chase, Quickbooks). This is a concept we may reference in docs / user interface but does not yet exist as an actual entity in the Venice API / Database.
|Source code adhering to the
Integration or an aggregator connector (e.g. Plaid) that provides many
|An integration represents a
Provider supported by a
Connector. There can be multiple integrations for a single provider if multiple connectors support the same provider (e.g. Merge and Railz both gives you the ability to connect to Quickbooks, in addition we have a direct Quickbooks connector for a total of 3 Quickbooks Integrations).
|A specific configuration of a Connector. Contains developer account credentials (e.g.
client_secret), and misc configs (
production). Some connectors does not require configuration (e.g. Postgres). In the future can also contain sync settings (e.g. Automatically sync all Plaid items using this config to our main postgres Resource).
|Associated with a specific
Connector Config. Contains customer credentials (e.g.
access_token) and gives you the ability to call
Provider APIs. Typically created by an
End User but could also created by you in the dashboard (which then belongs to your organization). Resource can also be used as either a Source or Destination within a Pipeline
|End User (Your customer)
|Pipeline moves data from a Source to a Destination and contains persistent state used for incremental syncs.
When we say “connect” in the user interface, we mean invoking a connector to create a resource.
Used in a sentence: A Pipeline simply connects a data Resource to/from Venice which transmits data across the Venice protocol.
Join our community
Join our community of founders & developers building the future of finance together
Improve the documentation
Help us keep the documentation as clear as possible. We welcome pull requests!