> ## Documentation Index
> Fetch the complete documentation index at: https://docs.nekt.com/llms.txt
> Use this file to discover all available pages before exploring further.

# PipeRun as a data source

> Bring data from PipeRun CRM to Nekt.

PipeRun is a Brazilian CRM platform for managing sales funnels, deals, contacts, companies, activities, and commercial
proposals. This connector extracts the whole sales operation — deals and their stage history, contacts and companies
(including custom fields), activities, calls, notes, emails, proposals with installments and payments, goals, and all
the supporting configuration entities.

## 1. Add your PipeRun access

1. In the [Sources](https://app.nekt.ai/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](https://developers.pipe.run/docs/token-autentica%C3%A7%C3%A3o).
   * **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.

<Info>If you don't see data you were expecting in a stream, remember the connector reads the API with the permissions of the user who owns the token — a manager (G1) user sees everything. If that's not the issue, feel free to get in touch and we'll help you out!</Info>

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](https://docs.nekt.com/get-started/core-concepts/catalog-layers) 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](https://docs.nekt.com/get-started/core-concepts/types-of-sync).

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](https://docs.nekt.com/runs/scheduling-and-triggers), 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](https://docs.nekt.com/get-started/core-concepts/resource-control).
* Determine when to execute an **Additional [Full Sync](https://docs.nekt.com/get-started/core-concepts/types-of-sync#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](https://app.nekt.ai/sources) page. Now, for you to be able to see it on your [Catalog](https://app.nekt.ai/catalog), you have to wait for the pipeline to run. You can now monitor it on the [Sources](https://app.nekt.ai/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

Most streams sync **incrementally** using each entity's update timestamp (deal stage history uses the stage-entry
date). Reference tables such as cities and CNAEs are always synced as full tables.

### Sales

| Stream                 | Description                                                                          |
| ---------------------- | ------------------------------------------------------------------------------------ |
| `deals`                | Deals (opportunities) with stage, owner, value, MRR value, temperature, and tags.    |
| `deal_stage_histories` | Every movement of a deal between funnel stages, with entry/exit dates and values.    |
| `deal_items`           | Products and services attached to each deal, with quantities, discounts, and totals. |
| `deal_custom_fields`   | Custom-field values filled on deals.                                                 |
| `deal_lost_reasons`    | Loss reasons configured for deals.                                                   |
| `pipelines`            | Sales funnels of the account.                                                        |
| `pipeline_stages`      | Stages of each sales funnel.                                                         |
| `goals`                | Advanced goals with their scope and processed results per user/team.                 |

### Contacts

| Stream                  | Description                                                           |
| ----------------------- | --------------------------------------------------------------------- |
| `persons`               | Contacts with addresses, emails, phones, tags, and custom fields.     |
| `person_custom_fields`  | Custom-field values filled on persons.                                |
| `companies`             | Companies with tax IDs, addresses, segment, and classification flags. |
| `company_custom_fields` | Custom-field values filled on companies.                              |
| `company_segments`      | Market segments configured for companies.                             |

### Engagement

| Stream            | Description                                                     |
| ----------------- | --------------------------------------------------------------- |
| `activities`      | Tasks, meetings, and other activities linked to deals.          |
| `activity_types`  | Types of activities configured in the account.                  |
| `calls`           | Phone call history with numbers, duration, and recording links. |
| `notes`           | Notes registered on deals, companies, and persons.              |
| `emails`          | Emails sent and received through PipeRun.                       |
| `email_templates` | Email templates configured in the account.                      |

### Proposals and payments

| Stream                     | Description                                                       |
| -------------------------- | ----------------------------------------------------------------- |
| `proposals`                | Commercial proposals with values, status, and included items.     |
| `proposal_models`          | Proposal models (templates).                                      |
| `proposal_layouts`         | Proposal layouts.                                                 |
| `proposal_parcels`         | Installments of each proposal, with due dates and payment status. |
| `proposal_parcel_payments` | Payments registered for proposal installments.                    |
| `payment_methods`          | Payment methods configured in the account.                        |
| `payment_method_types`     | Types of payment methods available in PipeRun.                    |

### Catalog

| Stream                 | Description                                        |
| ---------------------- | -------------------------------------------------- |
| `items`                | Catalog items — products, services, and MRR items. |
| `item_characteristics` | Characteristics configurable for items.            |
| `item_categories`      | Categories of catalog items.                       |
| `measurement_units`    | Units of measurement for items.                    |

### Configuration and reference

| Stream          | Description                                                   |
| --------------- | ------------------------------------------------------------- |
| `users`         | Users of the account, with permission level.                  |
| `teams`         | Sales teams and their members.                                |
| `team_groups`   | Groups of teams.                                              |
| `custom_fields` | Custom field definitions (for deals, persons, and companies). |
| `custom_forms`  | Custom forms and their fields.                                |
| `tags`          | Tags for deals, persons, and companies.                       |
| `origins`       | Origins (lead sources).                                       |
| `origin_groups` | Groups of origins.                                            |
| `regions`       | Regions and microregions.                                     |
| `datalists`     | Data lists and their fields.                                  |
| `cities`        | Brazilian cities reference table.                             |
| `cnaes`         | CNAE (economic activity) reference table.                     |

About the columns you'll see in the Catalog:

* 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

<Snippet file="agent-skills-intro.mdx" />

<Card title="Download PipeRun skills file" icon="wand-magic-sparkles" href="/sources/piperun.md">
  PipeRun connector documentation as plain markdown, for use in AI agent contexts.
</Card>