Crossbeam (v1) | Stitch Documentation

Crossbeam is in beta
Crossbeam is currently in beta. The info in this guide is subject to change.

Crossbeam is supported by the Singer community
This integration is powered by Singer's Crossbeam tap. For support, visit the GitHub repo or join the Singer Slack.

Crossbeam integration summary

Stitch’s Crossbeam integration replicates data using the Crossbeam API. Refer to the Schema section for a list of objects available for replication.

Crossbeam feature snapshot

A high-level look at Stitch's Crossbeam (v1) integration, including release status, useful links, and the features supported in Stitch.

STITCH
Release status	Beta	Supported by	Singer Community
Stitch plan	Standard	API availability	Available
Singer GitHub repository	singer-io/tap-crossbeam
REPLICATION SETTINGS
Anchor Scheduling	Supported	Advanced Scheduling	Supported
Table-level reset	Unsupported	Configurable Replication Methods	Unsupported
DATA SELECTION
Table selection	Supported	Column selection	Supported
Select all	Supported
TRANSPARENCY
Extraction Logs	Supported	Loading Reports	Supported

Connecting Crossbeam

Crossbeam setup requirements

To set up Crossbeam in Stitch, you need:

A Crossbeam application. For information on how to create one, see Crossbeam’s Developer Docs.

Step 1: Obtain your Crossbeam Uuid

Login to your Crossbeam account.
In the upper right-hand corner of the home page, click on your organization’s avatar.
In the dropdown menu, click Settings.
On the Settings page you’ll see your ogranization’s avatar and name. Underneath the name is the Uuid. Copy the Uuid and keep it readily available to continue with the integration.

Step 2: Add Crossbeam as a Stitch data source

Sign into your Stitch account.
On the Stitch Dashboard page, click the Add Integration button.
Click the Crossbeam icon.
Enter a name for the integration. This is the name that will display on the Stitch Dashboard for the integration; it’ll also be used to create the schema in your destination.

For example, the name “Stitch Crossbeam” would create a schema called stitch_crossbeam in the destination. Note: Schema names cannot be changed after you save the integration.
In the Organization Uuid field, paste the Crossbeam Uuid that you obtained in step 1.

Step 3: Define the historical replication start date

The Sync Historical Data setting defines the starting date for your Crossbeam integration. This means that:

For tables using Key-based Incremental Replication, data equal to or newer than this date will be replicated to your destination.
For tables using Full Table Replication, all data - including records that are older, equal to, or newer than this date - will be replicated to your destination.

Change this setting if you want to replicate data beyond Crossbeam’s default setting of 1 year. For a detailed look at historical replication jobs, check out the Syncing Historical SaaS Data guide.

Step 4: Create a replication schedule

Replication schedules affect the time Extraction begins, not the time to data loaded. Refer to the Replication Scheduling documentation for more information.

In the Replication Frequency section, you’ll create the integration’s replication schedule. An integration’s replication schedule determines how often Stitch runs a replication job, and the time that job begins.

Crossbeam integrations support the following replication scheduling methods:

Replication Frequency
Anchor Scheduling
Advanced Scheduling using Cron (Advanced or Premium plans only)

To keep your row usage low, consider setting the integration to replicate less frequently. See the Understanding and Reducing Your Row Usage guide for tips on reducing your usage.

Step 5: Set objects to replicate

Is an object missing or not replicating? Verify that the object meets the requirements for selection and replication.

The last step is to select the tables and columns you want to replicate. Learn about the available tables for this integration.

Note: If a replication job is currently in progress, new selections won’t be used until the next job starts.

For Crossbeam integrations, you can select:

Individual tables and columns
All tables and columns

Click the tabs to view instructions for each selection method.

In the integration’s Tables to Replicate tab, locate a table you want to replicate.
To track a table, click the checkbox next to the table’s name. A blue checkmark means the table is set to replicate.
To track a column, click the checkbox next to the column’s name. A blue checkmark means the column is set to replicate.
Repeat this process for all the tables and columns you want to replicate.
When finished, click the Finalize Your Selections button at the bottom of the screen to save your selections.

Important: Using the Select All feature will overwrite any previous selections. However, selections aren’t final until Finalize Your Selections is clicked. Clicking Cancel will restore your previous selections. Refer to the Select All guide for more info about this feature.

Click into the integration from the Stitch Dashboard page.
Click the Tables to Replicate tab.
In the list of tables, click the box next to the Table Names column.
In the menu that displays, click Track all Tables and Fields:
Click the Finalize Your Selections button at the bottom of the page to save your data selections.

Initial and historical replication jobs

After you finish setting up Crossbeam, its Sync Status may show as Pending on either the Stitch Dashboard or in the Integration Details page.

For a new integration, a Pending status indicates that Stitch is in the process of scheduling the initial replication job for the integration. This may take some time to complete.

Initial replication jobs with Anchor Scheduling

If using Anchor Scheduling, an initial replication job may not kick off immediately. This depends on the selected Replication Frequency and Anchor Time. Refer to the Anchor Scheduling documentation for more information.

Free historical data loads

The first seven days of replication, beginning when data is first replicated, are free. Rows replicated from the new integration during this time won’t count towards your quota. Stitch offers this as a way of testing new integrations, measuring usage, and ensuring historical data volumes don’t quickly consume your quota.

Replication will continue after the seven days are over. If you’re no longer interested in this source, be sure to pause or delete the integration to prevent unwanted usage.

Crossbeam table reference

Schemas and versioning

Schemas and naming conventions can change from version to version, so we recommend verifying your integration’s version before continuing.

The schema and info displayed below is for version 1 of this integration.

This is the latest version of the Crossbeam integration.

Table and column names in your destination

Depending on your destination, table and column names may not appear as they are outlined below.

For example: Object names are lowercased in Redshift (CusTomERs > customers), while case is maintained in PostgreSQL destinations (CusTomERs > CusTomERs). Refer to the Loading Guide for your destination for more info.

partners

View table schema on GitHub

Replication Method :	Full Table	Primary Key :	id
API endpoint :	get Partners

The partners table contains information about your partners as well as partner invitations sent to you in your Crossbeam account.

partners table schema

id
INTEGER

The partner ID.

clearbit_domain
STRING

domain
STRING

logo_url
STRING

name
STRING

url
STRING

users
ARRAY

Click to expand users

first_name
STRING

gravatar_url
STRING

id
INTEGER

last_name
STRING

partners (table), users (attribute)

uuid
STRING

partner_populations

View table schema on GitHub

Replication Method :	Full Table	Primary Key :	id
API endpoint :	get Partner

The partner_populations table contains information about the populations that your partners have shared with you in your Crossbeam account.

partner_populations table schema

id
INTEGER

The partner population ID.

name
STRING

organization_id
INTEGER

population_type
STRING

populations

View table schema on GitHub

Replication Method :	Full Table	Primary Key :	id
API endpoint :	get Populations

The populations table contains information about all of your populations in your Crossbeam account.

populations table schema

id
INTEGER

The population ID.

base_schema
STRING

base_table
STRING

current_version
OBJECT

Click to expand current_version

first_processed_at
DATE-TIME

id
INTEGER

is_active
BOOLEAN

populations (table), current_version (attribute)

filter_expression
ARRAY

Click to expand filter_expression

value
STRING

populations (table), filter_expression (attribute)

filter_parts
ARRAY

Click to expand filter_parts

column
STRING

id
INTEGER

label
STRING

operand
STRING

operator
STRING

schema
STRING

table
STRING

populations (table), filter_parts (attribute)

name
STRING

population_type
STRING

source_id
INTEGER

threads

View table schema on GitHub

Replication Method :	Full Table	Primary Key :	id
API endpoint :	get Threads

The threads table contains information about all threads initiated by you in your Crossbeam account.

threads table schema

id
STRING

The thread ID.

author_id
INTEGER

company_domain
STRING

company_name
STRING

created_at
DATE-TIME

directionality
STRING

is_open
BOOLEAN

is_unread
BOOLEAN

last_comment_at
DATE-TIME

last_viewed_at
DATE-TIME

organization_id
INTEGER

owner_id
INTEGER

partner_organization_id
INTEGER

partner_owner_id
INTEGER

person_email
STRING

record_id
STRING

source_id
INTEGER

title
STRING

total_messages
INTEGER

updated_at
DATE-TIME

thread_timelines

View table schema on GitHub

Replication Method :	Full Table	Primary Key :	id
API endpoint :	get ThreadTimeline

The thread_timelines table contains information about the activity for any given thread-id in your Crossbeam account. This is a child table of threads.

thread_timelines table schema

id
STRING

The thread ID of the timeline.

acting_organization_id
INTEGER

created_at
DATE-TIME

event_data
OBJECT

Click to expand event_data

acting_user_id
INTEGER

thread_timelines (table), event_data (attribute)

event_type
STRING

is_private
BOOLEAN

message
OBJECT

Click to expand message

content
STRING

edited_at
DATE-TIME

is_deleted
BOOLEAN

user_id
INTEGER

thread_timelines (table), message (attribute)

Questions? Feedback?

Did this article help? If you have questions or feedback, feel free to submit a pull request with your suggestions, open an issue on GitHub, or reach out to us.

Related	Troubleshooting
Destination & Integration Compatibility Replication Scheduling Syncing Historical SaaS Data Resetting Replication Keys Nested Data Structures & Row Count Impact	Third-Party Downtime Understanding & Reducing Your Usage Re-Authorizing Integrations Replication Issues