Skip to main content
Ramper Pipeline is the CRM of the Brazilian B2B sales platform Ramper. It organizes companies, contacts, deals and activities across customizable sales funnels, and its API exposes each of those as a readable collection — which is what this connector brings into your Catalog.
Ramper sells three products under the same brand: Prospect (sales engagement and cadences), Marketing, and Pipeline (this CRM). They keep separate databases and exchange records by pushing them to each other, so this connector reads Pipeline only. Ramper Prospect does not expose a read API, so cadence, email and engagement data cannot be extracted from it.

​
Configuring Ramper Pipeline as a Source

In the Sources tab, click on the “Add source” button located on the top right of your screen. Then, select the Ramper Pipeline option from the list of connectors. Click Next and you’ll be prompted to add your access.

​
1. Add account access

Ramper Pipeline authenticates every request with a single API token that does not expire.
  • API Token: In Ramper Pipeline, click your avatar in the top right corner, open API, and copy the token shown there.
Generating a new token in Ramper invalidates the previous one. Every integration already using the old token — your ERP, an automation tool, or this connector — stops working until it is updated. If other tools already read from Ramper, copy the existing token rather than creating another one.
The following optional and advanced settings are also available:
  • Initial sync date (Advanced): The earliest record modification date to read on the first sync. Later runs continue from where the previous one stopped. Leave it empty to read your full history. The funnel, stage, task type, user and custom field tables ignore this setting and are always read in full.
  • Lookback window (Advanced): (Default: 1 day) How many days before the last sync the incremental tables re-read on every run, so a record edited while the previous sync was running is not missed. Set 0 to disable.
  • Page size (Advanced): (Default: 100) Records requested per page. Ramper does not publish a maximum.
  • Requests per minute (Advanced): (Default: 120) How fast this source is allowed to call the API. Ramper does not publish a rate limit for this API, so the connector holds a modest pace of its own. Raise it if syncs are slow and you see no rate-limit warnings. Set 0 to remove the limit.
  • Base URL (Advanced): Only needed if Ramper told you to use a different address for your account.
Once you’re done, click Next.

​
2. Select streams

Choose which data streams you want to sync.
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: you can choose between INCREMENTAL and FULL_TABLE.
    • Incremental: every time the extraction happens, we’ll get only the new data - which is good if, for example, you want to keep every record ever fetched.
    • Full table: every time the extraction happens, we’ll get the current state of the data - which is good if, for example, you don’t want to have deleted data in your catalog.
Once you are done configuring, click Next.

​
4. Configure data source

Describe your data source for easy identification within your organization, not exceeding 140 characters. 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). Optionally, you can define some additional settings:
  • 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.
  • 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.
Once you are ready, click Next to finalize the setup.

​
5. Check your new source

You can view your new source on the 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, you need at least one successful source run.

​
Streams and Fields

​
Available streams

The five configuration tables are always read in full. A funnel, stage, task type or custom field you delete in Ramper has to disappear from your Catalog too, and an incremental read would leave it behind forever. users has no modification date in the API at all.

​
Fields by stream

​
Data Model

The following diagram shows how the tables relate. Opportunities sit at the centre: each one belongs to a stage of a funnel, points at a company and a contact, and collects tasks.
  • opportunities — one row per deal, with its value, status, stage and funnel.
  • companies and persons — the organizations and people the deals belong to.
  • pipes and stages — how your funnels are configured. Join opportunities.stageId to stages.id, or use pipe_id on the opportunity directly.
  • tasks — activities scheduled against an opportunity, company or contact.
  • users — who owns each record. Every table carries owner_id.
  • additional_fields — the definitions behind the additionalFields column on opportunities, companies and contacts.

​
Implementation Notes

​
Archived funnels and stages are included

Ramper’s API returns only active funnels and stages by default. This connector asks for both active and inactive ones, so an archived funnel still appears in your Catalog with active set to false. This matters for reporting: an opportunity you closed a year ago still points at the stage it was in, and if that stage has since been archived, leaving it out would make those opportunities impossible to label. Filter on active yourself when you want only the funnels currently in use.

​
Things to know

  • Opportunities carry their funnel directly. The API identifies only the stage on an opportunity, but the connector resolves the funnel and writes it to pipe_id and pipe_name, so you can group by funnel without joining the stages table.
  • Custom field values are stored as JSON. The additionalFields column on opportunities, companies and contacts holds the values as the API returned them. Join their identifiers against the additional_fields table to get names, types and option lists.
  • Nested records are stored as JSON text. Columns such as company, person, opportunityProducts and createdBy hold the API’s object exactly as it arrived. This keeps your table structure stable as Ramper evolves its API. The information you are most likely to query — the record’s owner, its stage, its funnel — is already available as regular columns.
  • Configuration tables are small and re-read on every run. Funnels, stages, task types, users and custom fields are refreshed in full each sync, which costs a request or two and keeps deletions in step.
  • Ramper publishes no rate limit for this API. The connector paces itself instead. If a sync is slow and you see no rate-limit warnings in the run log, raise Requests per minute in the source settings.
  • Ramper Prospect data is not available here. Cadences, email sends, opens, clicks and replies live in Ramper Prospect, which exposes no read API. Only leads that Prospect pushes into Pipeline reach this connector, as ordinary opportunities and contacts.

​
Troubleshooting

​
Skills for agents

Download Ramper Pipeline skills file

Ramper Pipeline connector documentation as plain markdown, for use in AI agent contexts.