Perpetuus as a data source

​

1. Add your Perpetuus access

1. In the 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.

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 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 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, 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

​

Boards

​

Sales

​

Contacts

​

Engagement

• 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