PipeRun as a data source

​

1. Add your PipeRun access

1. In the Sources tab, click on the “Add source” button located on the top right of your screen. Then, select the PipeRun option from the list of connectors.
2. Click Next and you’ll be prompted to add your access.
   • API Token: the personal API token of a PipeRun user. In PipeRun, open the user profile screen — the token is shown just below the user photo. Use a manager (G1) user, so the token can read all the account data; the connector only sees what that user is allowed to see. For more information, check the official documentation.
   • Start Date (advanced): earliest record date to sync for incremental streams, based on each entity’s update timestamp. Leave empty to sync all history.
3. Click Next.

​

2. Select your PipeRun streams

1. The next step is letting us know which streams you want to bring. You can select entire groups of streams or only a subset of them.

   Tip: The stream can be found more easily by typing its name.

2. Click Next.

​

3. Configure your PipeRun data streams

1. Customize how you want your data to appear in your catalog. Select a name for each table (which will contain the fetched data) and the type of sync.

• Layer: companies in the Growth plan can choose in which layer the tables with the extracted data will be placed.
• Table name: we suggest a name, but feel free to customize it. You have the option to add a prefix to all tables at once and make this process faster!
• Sync Type: depending on the data you are bringing to the lake, you can choose between INCREMENTAL and FULL_TABLE. Read more about Sync Types here.

2. Click Next.

​

4. Configure your PipeRun data source

1. Describe your data source for easy identification within your organization. You can inform things like what data it brings, to which team it belongs, etc.
2. To define your Trigger, consider how often you want data to be extracted from this source. This decision usually depends on how frequently you need the new table data updated (every day, once a week, or only at specific times).
3. Optionally, you can define some additional settings (if available).

• Configure Delta Log Retention and determine for how log we should store old states of this table as it gets updated. Read more about this resource here.
• Determine when to execute an Additional Full Sync. This will complement the incremental data extractions, ensuring that your data is completely synchronized with your source every once in a while.

​

Check your new source!

1. Click Next to finalize the setup. Once completed, you’ll receive confirmation that your new source is set up!
2. You can view your new source on the Sources page. Now, for you to be able to see it on your Catalog, you have to wait for the pipeline to run. You can now monitor it on the Sources page to see its execution and completion. If needed, manually trigger the pipeline by clicking on the refresh icon. Once executed, your new table will appear in the Catalog section.

If you encounter any issues, reach out to us via Slack, and we’ll gladly assist you!

​

Available streams

​

Sales

​

Contacts

​

Engagement

​

Proposals and payments

​

Catalog

​

Configuration and reference

• Every stream has id as its primary key.
• Fields that hold nested objects or lists (e.g. a deal’s tags, a proposal’s items, a person’s contact_emails) arrive as JSON strings, ready to be parsed in a Query or Notebook.
• Streams can be joined together by their id columns (e.g. deals.stage_id to pipeline_stages.id).

​

Skills for agents