> ## 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.
# Ploomes as a data source
> Bring data from Ploomes to Nekt.
Ploomes is a CRM and business automation platform that helps businesses manage customer relationships and automate sales processes. It provides tools for lead management, sales pipeline tracking, and marketing automation to improve customer engagement and drive growth.
## Configuring Ploomes as a Source
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 **Ploomes** option from the list of connectors.
Click **Next** and you'll be prompted to add your access.
### 1. Add account access
You'll need to authorize Nekt to access your Ploomes data. The following configurations are available:
* **API Key**: Check Ploomes's documentation to know where you can find your API Key.
* **Start Date**: The date of the first record you want to sync with. Use the format DD/MM/YYYY.
Once you're done, click **Next**.
### 2. Select streams
Choose which data streams you want to sync. For faster extractions, select only the streams that are relevant to your analysis. You can select entire groups of streams or pick specific ones.
> Tip: The stream can be found more easily by typing its name.
Select the streams and click **Next**.
### 3. Configure data streams
Customize how you want your data to appear in your catalog. Select the desired layer where the data will be placed, a folder to organize it inside the layer, a name for each table (which will effectively contain the fetched data) and the type of sync.
* **Layer**: choose between the existing layers on your catalog. This is where you will find your new extracted tables as the extraction runs successfully.
* **Folder**: a folder can be created inside the selected layer to group all tables being created from this new data source.
* **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).
Once you are done configuring, click **Next**.
### 4. Configure data source
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.
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).
Optionally, you can define some additional settings (if available):
* Configure Delta Log Retention and determine for how long 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).
Once you are ready, click **Next** to finalize the setup.
### 5. Check your new source
You can view your new source on the [Sources](https://app.nekt.ai/sources) page. If needed, manually trigger the source extraction by clicking on the arrow button. Once executed, your data will appear in your Catalog.
For you to be able to see it on your [Catalog](https://app.nekt.ai/catalog), you need at least one successful source run.
# Streams and Fields
Below you'll find the available data streams from Ploomes:
Stream for retrieving deal (opportunity) records from your Ploomes pipeline.
**Key Fields:**
| Field | Type | Description |
| :----------------- | :-------- | :---------------------------------------------------------------------------------------------- |
| `id` | String | Unique identifier for the deal |
| `last_update_date` | Timestamp | Timestamp of when the deal was last updated. Used as the replication key for incremental syncs. |
| `LossReason` | Object | Expanded field containing details about why a deal was lost. |
| `Status` | Object | Expanded field containing the deal's status. |
| `Stage` | Object | Expanded field containing the deal's current pipeline stage. |
| `OtherProperties` | Object | Expanded field containing additional custom properties of the deal. |
| `Tags` | Array | Expanded field containing tags associated with the deal. |
Stream for retrieving contact records.
**Key Fields:**
| Field | Type | Description |
| :----------------- | :-------- | :------------------------------------------------------------------------------------------------- |
| `id` | String | Unique identifier for the contact |
| `last_update_date` | Timestamp | Timestamp of when the contact was last updated. Used as the replication key for incremental syncs. |
# Implementation Notes
### API Limits & Pagination
* **Date Window Pagination**: To avoid 504 Gateway Timeouts caused by the Ploomes API on deep offsets, high-volume streams with heavy expansions (such as the **Deals** stream) utilize a specialized fixed date-window pagination.
* During extraction, the connector automatically splits the replication key range into monthly contiguous windows (from the `start_date` up to the current date). This keeps the offset (`$skip`) shallow within each window, ensuring reliable replication and mitigating API stability issues when handling large datasets.
* **Filter Encoding**: The connector formats API filters carefully (e.g., utilizing spaces instead of encoded `+` symbols) because the Ploomes server rejects `%2B` encoding for OData filter separators with a `400 Syntax error`.
## Skills for agents
Ploomes connector documentation as plain markdown, for use in AI agent contexts.