# Crossbeam (v1) Information note **Crossbeam is in beta** Crossbeam is currently in beta. The info in this guide is subject to change. Information note **Crossbeam is supported by the Singer community** This integration is powered by [Singer's](https://www.singer.io/) Crossbeam tap. For support, [visit the GitHub repo](https://github.com/singer-io/tap-crossbeam) or [join the Singer Slack](https://singer-slackin.herokuapp.com/). ## Crossbeam integration summary Stitch’s Crossbeam integration replicates data using the [Crossbeam API](https://developers.crossbeam.com/). Refer to the [Schema](https://help.qlik.com/en-US/stitch/integrations/saas/crossbeam#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](https://help.qlik.com/en-US/stitch/integrations/identify-an-integration-version)** | Beta | **Supported by**

the Info icon

Indicates if the integration is supported by Stitch or the Singer community. | [Singer Community](https://www.singer.io/) | | **Stitch plan**

the Info icon

The type of Stitch plan required to use the integration. | Standard | **[API availability](https://help.qlik.com/en-US/stitch/developers/stitch-connect/guides/source-destination-reference)**

the Info icon

Indicates if the integration is available as a source in Stitch Connect. | the Success icon

This version of the integration is available via the API.


Available | | **Singer GitHub repository** | [singer-io/tap-crossbeam](https://github.com/singer-io/tap-crossbeam) | | | | **REPLICATION SETTINGS** | | | | | **[Anchor Scheduling](https://help.qlik.com/en-US/stitch/replication/replication-scheduling/anchor-scheduling)**

the Info icon

A type of replication scheduling where an integration's Replication Frequency is anchored to a time you select. | the Success icon

This feature is supported for this version of the integration.


Supported | **[Advanced Scheduling](https://help.qlik.com/en-US/stitch/replication/replication-scheduling/advanced-scheduling)**

the Info icon

A type of replication scheduling that allows you to specify granular start times for data extraction using cron expressions. | the Success icon

This feature is supported for this version of the integration.


Supported | | **Table-level reset**

the Info icon

Indicates if data can be reset at the table level. If unsupported, data can only be reset at the integration level. | the Remove icon

Table-level resets are not supported for this integration. Resets are only supported at the integration level.


Unsupported | **[Configurable Replication Methods](https://help.qlik.com/en-US/stitch/replication/replication-methods)**

the Info icon

Indicates if Replication Methods can be defined by you for tables in the integration. | the Remove icon

Configurable Replication Methods are not supported for this integration. Stitch will use pre-defined replication methods for tables you set to replicate.


Unsupported | | **DATA SELECTION** | | | | | **Table selection**

the Info icon

The ability to select individual tables for replication in the Stitch interface. If table selection is unavailable, all tables and all the columns they contain will be set to replicate by default. | the Success icon

This feature is supported for this version of the integration.


Supported | **Column selection**

the Info icon

The ability to select individual columns for replication in the Stitch interface. If column selection is unavailable, all columns will be set to replicate by default. | the Success icon

This feature is supported for this version of the integration.


Supported | | **Select all**

the Info icon

Indicates if the integration supports selecting all available tables and columns. | the Success icon

Supported


Supported | | | | **TRANSPARENCY** | | | | | **[Extraction Logs](https://help.qlik.com/en-US/stitch/replication/extractions/integration-extraction-logs)**

the Info icon

Logs detailing the Extraction phase of the replication process for a given integration. Includes error info, should an error occur. | the Success icon

This feature is supported for this version of the integration.


Supported | **[Loading Reports](https://help.qlik.com/en-US/stitch/replication/integration-loading-reports)**

the Info icon

Reports detailing the Loading phase of the replication process for a given integration. Includes the number of rows loaded for each table and error info, should an error occur. | the Success icon

This feature is supported for this version of the integration.


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](https://developers.crossbeam.com/#authentication). ### Step 1: Obtain your Crossbeam Uuid 1. Login to your Crossbeam account. 2. In the upper right-hand corner of the home page, click on your organization’s avatar. 3. In the dropdown menu, click **Settings**. 4. 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 1. [Sign into your Stitch account](https://app.stitchdata.com/). 2. On the Stitch Dashboard page, click the **Add Integration** button. 3. Click the **Crossbeam** icon. 4. 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. 5. In the **Organization Uuid** field, paste the Crossbeam Uuid that you obtained in [step 1](https://help.qlik.com/en-US/stitch/integrations/saas/crossbeam#obtain-uuid). ### Step 3: Define the historical replication start date The Sync Historical Data setting defines the starting date for your Crossbeam integration. This means that data **equal to or newer than this date** will be replicated to your data warehouse. 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](https://help.qlik.com/en-US/stitch/replication/syncing-historical-saas-data-resetting-replication-keys) guide. ### Step 4: Create a replication schedule Information note Replication schedules affect the time Extraction begins, not the time to data loaded. Refer to the [Replication Scheduling](https://help.qlik.com/en-US/stitch/replication/replication-scheduling) documentation for more information. In the **Replication Frequency** section, you’ll create the integration’s [replication schedule](https://help.qlik.com/en-US/stitch/replication/replication-scheduling). 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](https://help.qlik.com/en-US/stitch/replication/replication-scheduling/replication-frequency) * [Anchor Scheduling](https://help.qlik.com/en-US/stitch/replication/replication-scheduling/anchor-scheduling) * [Advanced Scheduling using Cron](https://help.qlik.com/en-US/stitch/replication/replication-scheduling/advanced-scheduling) (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](https://help.qlik.com/en-US/stitch/getting-started/understanding-stitch-usage) for tips on reducing your usage. ### Step 5: Set objects to replicate Information note **Is an object missing or not replicating?** Verify that the object meets the requirements for [selection](https://help.qlik.com/en-US/stitch/replication/extractions/data-selection/setting-tables-and-columns-to-replicate#selection-requirements) and [replication](https://help.qlik.com/en-US/stitch/replication/extractions/data-selection/setting-tables-and-columns-to-replicate#replication-requirements). The last step is to select the tables and columns you want to replicate. [Learn about the available tables for this integration.](https://help.qlik.com/en-US/stitch/integrations/saas/crossbeam#schema) **Note**: If a replication job is currently in progress, new selections won’t be used until the next job starts. * Selection options * Individual tables and columns * All tables and columns For Crossbeam integrations, you can select: 1. **Individual tables and columns** 2. **All tables and columns** Click the tabs to view instructions for each selection method. 1. In the integration’s **Tables to Replicate tab**, locate a table you want to replicate. 2. To track a table, click the **checkbox** next to the table’s name. A blue checkmark means the table is set to replicate. 3. To track a column, click the **checkbox** next to the column’s name. A blue checkmark means the column is set to replicate. 4. Repeat this process for all the tables and columns you want to replicate. 5. When finished, click the **Finalize Your Selections** button at the bottom of the screen to save your selections. Information note **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](https://help.qlik.com/en-US/stitch/replication/extractions/data-selection/setting-tables-and-columns-to-replicate#set-all-data-to-replicate) for more info about this feature. 1. Click into the integration from the Stitch Dashboard page. 2. Click the **Tables to Replicate** tab. 3. In the list of tables, click the box next to the **Table Names** column. 4. In the menu that displays, click **Track all Tables and Fields**: ![The Track all Tables and Fields menu in the Tables to Replicate tab](https://help.qlik.com/en-US/stitch/images/replication/select-all-tables-menu.png)The Track all Tables and Fields menu in the Tables to Replicate tabThe Track all Tables and Fields menu in the Tables to Replicate tab 5. 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.** Information note **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](https://help.qlik.com/en-US/stitch/replication/replication-scheduling#job-scheduling-and-anchor-times) 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. Information note **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 Information note **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. Information note **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](https://help.qlik.com/en-US/stitch/replication/loading/destination-guides) for your destination for more info. ### partner\_populations The `partner_populations` table contains information about the populations that your partners have shared with you in your Crossbeam account. | **Replication Method [](https://help.qlik.com/en-US/stitch/replication/replication-methods)[the Info icon](https://help.qlik.com/en-US/stitch/replication/replication-methods)[](https://help.qlik.com/en-US/stitch/replication/replication-methods)** | Full Table | | --- | --- | | **Primary Key ![](https://help.qlik.com/en-US/stitch/images/replication/primary-key-icon.svg)** | id | | **Useful links** | [partner_populations schema on GitHub](https://github.com/singer-io/tap-crossbeam/blob/master/tap_crossbeam/schemas/partner_populations.json "Opens in new tab: partner_populations schema on GitHub")


[Crossbeam API method](https://developers.crossbeam.com/#53c31e87-71ed-4712-85b5-65877d0c0a0f "Opens in new tab: Crossbeam API method") | partner\_populations table schema | **id**


INTEGER | | --- | | **name**


STRING | | **organization\_id**


INTEGER | | **population\_type**


STRING | ### partners The `partners` table contains information about your partners as well as partner invitations sent to you in your Crossbeam account. | **Replication Method [](https://help.qlik.com/en-US/stitch/replication/replication-methods)[the Info icon](https://help.qlik.com/en-US/stitch/replication/replication-methods)[](https://help.qlik.com/en-US/stitch/replication/replication-methods)** | Full Table | | --- | --- | | **Primary Key ![](https://help.qlik.com/en-US/stitch/images/replication/primary-key-icon.svg)** | id | | **Useful links** | [partners schema on GitHub](https://github.com/singer-io/tap-crossbeam/blob/master/tap_crossbeam/schemas/partners.json "Opens in new tab: partners schema on GitHub")


[Crossbeam API method](https://developers.crossbeam.com/#dd64387a-b410-40f3-9993-e87f1df96963 "Opens in new tab: Crossbeam API method") | partners table schema | **clearbit\_domain**


STRING | | --- | | **domain**


STRING | | **id**


INTEGER | | **logo\_url**


STRING | | **name**


STRING | | **url**


STRING | | **users**


ARRAY

This is a nested data structure. If your destination doesn't natively support nested data, attributes will be denested into a subtable. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>.

Click to expand users

first_name

STRING

gravatar_url

STRING

id

INTEGER

last_name

STRING

| | **uuid**


STRING | ### populations The `populations` table contains information about all of your populations in your Crossbeam account. | **Replication Method [](https://help.qlik.com/en-US/stitch/replication/replication-methods)[the Info icon](https://help.qlik.com/en-US/stitch/replication/replication-methods)[](https://help.qlik.com/en-US/stitch/replication/replication-methods)** | Full Table | | --- | --- | | **Primary Key ![](https://help.qlik.com/en-US/stitch/images/replication/primary-key-icon.svg)** | id | | **Useful links** | [populations schema on GitHub](https://github.com/singer-io/tap-crossbeam/blob/master/tap_crossbeam/schemas/populations.json "Opens in new tab: populations schema on GitHub")


[Crossbeam API method](https://developers.crossbeam.com/#514ea1c6-ca53-4bbb-9dee-e6793e7d1518 "Opens in new tab: Crossbeam API method") | populations table schema | **base\_schema**


STRING | | --- | | **base\_table**


STRING | | **current\_version**


OBJECT

This is a nested data structure. If your destination doesn't natively support nested data, attributes in this object will be flattened into the table. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>.

Click to expand current\_version

first_processed_at

DATE-TIME

id

INTEGER

is_active

BOOLEAN

| | **filter\_expression**


ARRAY

This is a nested data structure. If your destination doesn't natively support nested data, attributes will be denested into a subtable. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>. | | **filter\_parts**


ARRAY

This is a nested data structure. If your destination doesn't natively support nested data, attributes will be denested into a subtable. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>.

Click to expand filter\_parts

column

STRING

id

INTEGER

label

STRING

operand

STRING

operator

STRING

schema

STRING

table

STRING

| | **id**


INTEGER | | **name**


STRING | | **population\_type**


STRING | | **source\_id**


INTEGER | ### thread\_timelines 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`. | **Replication Method [](https://help.qlik.com/en-US/stitch/replication/replication-methods)[the Info icon](https://help.qlik.com/en-US/stitch/replication/replication-methods)[](https://help.qlik.com/en-US/stitch/replication/replication-methods)** | Full Table | | --- | --- | | **Primary Key ![](https://help.qlik.com/en-US/stitch/images/replication/primary-key-icon.svg)** | id | | **Useful links** | [thread_timelines schema on GitHub](https://github.com/singer-io/tap-crossbeam/blob/master/tap_crossbeam/schemas/thread_timelines.json "Opens in new tab: thread_timelines schema on GitHub")


[Crossbeam API method](https://developers.crossbeam.com/#6315ece6-1805-4132-9337-13bf4607e77a "Opens in new tab: Crossbeam API method") | thread\_timelines table schema | **acting\_organization\_id**


INTEGER | | --- | | **created\_at**


DATE-TIME | | **event\_data**


OBJECT

This is a nested data structure. If your destination doesn't natively support nested data, attributes in this object will be flattened into the table. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>.

Click to expand event\_data

acting_user_id

INTEGER

| | **event\_type**


STRING | | **id**


STRING | | **is\_private**


BOOLEAN | | **message**


OBJECT

This is a nested data structure. If your destination doesn't natively support nested data, attributes in this object will be flattened into the table. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>.

Click to expand message

content

STRING

edited_at

DATE-TIME

is_deleted

BOOLEAN

user_id

INTEGER

| ### threads The `threads` table contains information about all threads initiated by you in your Crossbeam account. | **Replication Method [](https://help.qlik.com/en-US/stitch/replication/replication-methods)[the Info icon](https://help.qlik.com/en-US/stitch/replication/replication-methods)[](https://help.qlik.com/en-US/stitch/replication/replication-methods)** | Full Table | | --- | --- | | **Primary Key ![](https://help.qlik.com/en-US/stitch/images/replication/primary-key-icon.svg)** | id | | **Useful links** | [threads schema on GitHub](https://github.com/singer-io/tap-crossbeam/blob/master/tap_crossbeam/schemas/threads.json "Opens in new tab: threads schema on GitHub")


[Crossbeam API method](https://developers.crossbeam.com/#4ab89b70-2b52-4405-a625-eeb09c0e7cef "Opens in new tab: Crossbeam API method") | threads table schema | **author\_id**


INTEGER | | --- | | **company\_domain**


STRING | | **company\_name**


STRING | | **created\_at**


DATE-TIME | | **directionality**


STRING | | **id**


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 |