Connectors / Service / Crossbeam

Crossbeam

Crossbeam

A partner ecosystem platform that enables companies to find overlapping customers and prospects with their partners, while keeping the rest of their data private and secure.

Overview

Crossbeam enables companies to perform account mapping, where they match their leads, opportunities, and customers against those of their partners, and share information to help both companies build a more valuable relationship with the client.

API INFO: The Base URL used for the crossbeam connector is https://api.crossbeam.com/v0.1. More information can be found on their main API documentation (v0.1) site. This is where users will also be able to find the API Limitations page.

Authentication

Within the workflow builder, highlight the Crossbeam connector.

In the Crossbeam connector properties panel to the right of the builder, click on the Authenticate tab and the 'Add new authentication' button.

This will result in a Tray.io authentication pop-up modal. The first page will ask you to name your authentication and select the type of authentication you wish to create ('Personal' or 'Organisational').

The next page asks you what scopes you want to give your authentication. Openid is mandatory for all Crossbeam authentications; you can then consult the API documentation to determine which scopes are needed for the endpoints you want to use.

When you have selected the scopes you want, click 'Create authentication', and then a new popup will appear, asking you to log in to Crossbeam.

Provide your username and password and click 'Login', and then authorise Tray to access your account with the scopes you selected.

Once you have added these fields to your Tray.io authentication popup window, click the 'Create authentication' button.

Go back to your settings authentication field (within the workflow builder properties panel), and select the recently added authentication from the dropdown options now available.

Your connector authentication setup should now be complete.

Available Operations

The examples below show one or two of the available connector operations in use.

  • Get user profile
  • List partners
  • List populations
  • List records
  • Search records

Please see the Full Operations Reference at the end of this page for details on all available operations for this connector.

Using the Raw HTTP Request ('Universal Operation')

As of version 1.0, you can effectively create your own operations.

This is a very powerful feature which you can put to use when there is an endpoint in Crossbeam which is not used by any of our operations.

To use this you will first of all need to research the endpoint in the Crossbeam API documentation v0.1, to find the exact format that Crossbeam will be expecting the endpoint to be passed in.

Note that you will only need to add the suffix to the endpoint, as the base URL will be automatically set (the base URL is picked up from the value you entered when you created your authentication).

The base URL for Crossbeam is: `https://api.crossbeam.com/\`

For example, say that the 'Get user profile' operation did not exist in our Crossbeam connector, and you wanted to use this endpoint. You would use the Crossbeam API docs to find the relevant endpoint - which in this case is a `GET` request called: `/users/me`.

More details about this endpoint can be found here.

As you can see there is also the option to include a query parameter, should you wish to do so. So if you know what your method, endpoint and details of your query parameters are, you can get the .................. information with the following settings:

Method: `GET`

Endpoint: `/v0.1/users/me`

Final outcome being: https://api.crossbeam.com/v0.1/users/me

IMPORTANT!: Most endpoints in the Crossbeam API require an organization ID to be provided in the `Xbeam-Organization` header. You can use the 'Get user profile' operation to retrieve the organisations your account belongs to.

Example Usage

TRAY POTENTIAL: Tray.io is extremely flexible. By design there is no fixed way of working with it - you can pull whatever data you need from other services and work with it using our core and helper connectors. This demo which follows shows only one possible way of working with Tray.io and the crossbeam connector. Once you've finished working through this example please see our Introduction to working with data and jsonpaths page and Data Guide for more details.

Below is an example of a way in which you could potentially use the Crossbeam connector, to retrieve a list of records, export those records to a CSV file, and then upload that CSV to Google Drive.

EXTRA AUTHS: In order to complete this workflow, you will also need to be authenticated with the Google Drive connector.

The steps will be as follows:

  1. Setup using a manual trigger and add a Crossbeam step, set to the 'List records' operation.
  2. Create a blank CSV file and add all the records form the previous step in the CSV using a loop.
  3. Export the CSV and upload it to Google Drive.

Your completed workflow should look similar to this:

1 - Setup Trigger & Add 'List records' Step

Select the manual trigger from the trigger options available.

From the connectors panel on the left, add a Crossbeam connector to your workflow. Set the operation to 'List records' and select the ID of the organization you want to retrieve records from.

Feel free to re-name your steps as you go along to make things clearer for yourself and other users. The operation names themselves often suffice.

2 - Create a blank CSV and add records to it

Add a CSV Editor step. Set the operation to 'Create CSV', and then add columns for each piece of data you want stored in the CSV.

Next, search for the Loop collection connector within your connector panel, and drag it into your workflow as your next step. Set your operation to 'Loop list'.

The Loop Collection connector allows you to iterate through a list of results. In this example, we will use it to iterate through the data found within the previous Crossbeam connector step.

In order to specify the list you want to loop through, start by using the list mapping icon (found next to the list input field, within the properties panel) to generate the connector-snake.

While hovering over the 'List records' step (with the tail end of the connector-snake), select `items` from the list of output properties displayed. This will auto-populate a jsonpath within your list input field, and update the type selector to jsonpath.

For more clarification on the pathways you have available, open the Debug panel to view your step's Input and Output.

JSONPATHS: For more information on what jsonpaths are and how to use jsonpaths with Tray.io, please see our Intro page and Data Guide for more details.
CONNECTOR-SNAKE: The simplest and easiest way to generate your jsonpaths is to use our feature called the Connector-snake. Please see the main page for more details.

Now, when the workflow is run, a list of records will be retrieved and then iterated over. But as of yet, nothing will be done with these iterated objects.

Drag another CSV Editor step inside the loop step. Set the operation to 'Add row'. Use the connector-snake to retrieve the ID of the blank CSV you created previously, and then assign the column names to their respective values from the loop connector.

Now, when run, this workflow will add data from each record to the CSV file.

3 - Export the CSV and upload it to Google Drive

After the loop, drag in another CSV Editor step. Set the operation to 'Export CSV', and use the connector-snake to assign it to the ID of the CSV you have been building in this workflow.

Next, drag in a Google Drive step. Set the operation to 'Upload file', and use the connector-snake to find the jsonpath for the CSV file from the 'Export CSV' step.

Now, when the workflow is run, it will create a CSV file out of record data from Crossbeam, and it will then export that CSV and upload it to Google Drive.

If anything goes wrong, you can use the debug panel to check the inputs and outputs of each step.

BEST PRACTICES: Whenever you do decide to create your own workflow, please make sure you take a look at our Managing data best practices guide.

All Operations

Latest version:

2.0