> ## 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.

# Perpetuus as a data source

> Bring data from Perpetuus CRM to Nekt.

Perpetuus is a Brazilian CRM that organizes the commercial operation into boards (funnels) with configurable phases and
dynamic fields, where each card represents an opportunity. This connector extracts the whole operation — boards with
their phases, fields, tags and access list, cards with their dynamic field values, contacts and their activity timeline,
tasks, comments, quotes, the product catalogue, segments, campaigns and teams.

## 1. Add your Perpetuus 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 Perpetuus option from the list of connectors.

2. Click **Next** and you'll be prompted to add your access.

   * **API Token**: generate it inside Perpetuus in **Settings → Organization → API tab**. The token inherits the permissions of the user who generated it, so use an **administrator** account — otherwise the connector only sees the boards that user is a member of.
   * **Organization ID**: the identifier (slug) of your organization, sent on every request. It's the name that appears in the app URL, for example `acme`.
   * **Start Date** (advanced): earliest record date to sync for the incremental streams. Leave empty to sync all history.

3. Click **Next**.

## 2. Select your Perpetuus 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 generated the token — an administrator sees every board. Some streams also depend on modules that may not be included in your Perpetuus plan (teams, quotes, products, campaigns); when a module isn't enabled, that stream is simply skipped. 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 Perpetuus 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 Perpetuus 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

Cards, contacts, contact activities and comments sync **incrementally** using their update or event timestamp. All the
other streams are synced as full tables, since the API doesn't expose an update timestamp for them.

### Boards

| Stream          | Description                                                                                                                          |
| --------------- | ------------------------------------------------------------------------------------------------------------------------------------ |
| `boards`        | Funnels of the organization, with their settings, currency, won/loss phases and access list.                                         |
| `board_phases`  | Phases (columns) of each board, in order, with their SLA in hours. Phase `order` 0 is the public entry form.                         |
| `board_fields`  | Definitions of the dynamic fields of every phase — label, slug, type and options. Use it to interpret the `fields` column of a card. |
| `board_tags`    | Tags available on each board.                                                                                                        |
| `board_members` | Access list of each board, one row per membership, identifying the owner, the editors and the members.                               |

### Sales

| Stream               | Description                                                                                                                 |
| -------------------- | --------------------------------------------------------------------------------------------------------------------------- |
| `cards`              | Opportunities of each board, with value, current phase, responsible members, tags, linked contact and dynamic field values. |
| `quotes`             | Commercial proposals with their items, discounts, totals and status.                                                        |
| `products`           | Catalogue of products and services available for quotes.                                                                    |
| `product_categories` | Categories used to organize the product catalogue.                                                                          |
| `pdf_templates`      | Templates used to render quotes and other documents as PDF.                                                                 |

### Contacts

| Stream               | Description                                                                                                               |
| -------------------- | ------------------------------------------------------------------------------------------------------------------------- |
| `contacts`           | People and companies, with tax IDs, address, responsible member and the additional data configured for your organization. |
| `contact_activities` | Timeline of each contact — creation, owner changes, cards won and lost, messages sent, notes and calls.                   |

### Engagement

| Stream      | Description                                                                                    |
| ----------- | ---------------------------------------------------------------------------------------------- |
| `tasks`     | Reminders and follow-ups linked to cards and boards, with due date, priority and recurrence.   |
| `comments`  | Comments registered on cards, both written by users and generated automatically by the system. |
| `segments`  | Dynamic contact audiences defined by filter rules, with the number of contacts matching them.  |
| `campaigns` | Mass WhatsApp, email and SMS dispatches, with their delivery and engagement counters.          |
| `teams`     | Sales teams with their leader and members. Requires the teams module in your Perpetuus plan.   |

About the columns you'll see in the Catalog:

* Every stream has `document_id` as its primary key — the string identifier Perpetuus uses across the API. The only exception is `board_members`, keyed by board, membership and role.
* Streams nested under a board carry a `board_id` column, so they can be joined back to `boards`.
* Fields that hold nested objects or lists — a card's `assignees`, `tags`, `fields` and `field_data`, a contact's `custom_fields`, a quote's `items` — arrive as JSON strings, ready to be parsed in a Query or Notebook.
* Frequently used references are also available as plain columns, so the most common joins need no parsing: `cards.contact_id`, `cards.current_phase_name`, `contacts.owner_email`, `campaigns.stats_sent` and so on.
* A card's dynamic values live in the `fields` column as a map of field slug to value. The matching slugs and their types are in `board_fields`.

## Skills for agents

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

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