Crossbeam

This documentation for the Crossbeam integration describes the technical capabilities of this integration, including authorization, scopes/permissions, and utilized endpoints. For more information on how to integrate Crossbeam, visit our connection instructions.

Version

This integration utilizes the Crossbeam REST API v0.1.

Base URL

The base URL used for all Crossbeam API endpoints:

https://api.crossbeam.com/v0.1

---

Authentication & Authorization

The DataGrail Crossbeam integration connects using OAuth 2.0 with the following credentials: Client ID and Client Secret.

Sensitive Credentials

Publicly exposing your API credentials can allow unauthorized access to Crossbeam API endpoints by a third party. DataGrail stores your API credentials encrypted and protected.

Scopes

The Crossbeam integration requires specific scopes that must be granted in order to function for a given capability.

Scope	Base	Access	System Detection
read:partnerships	✅		✅
read:reports		✅
openid	✅
offline_access	✅

Base Scopes

All base scopes must be granted in order to connect the integration with DataGrail. The remaining scopes are only required if enabling those capabilities

Endpoints Utilized

DataGrail uses the following endpoints to authorize and test the connection:

Method	Endpoint	Purpose	Docs
GET	/users/me	Validate connection
GET	https://auth.crossbeam.com/authorize	Request authorization
POST	https://auth.crossbeam.com/oauth/token	Get and refresh access token

---

Limits

Limits in Crossbeam are calculated using the leaky bucket algorithm. All requests that are made after rate limits have been exceeded are throttled and an HTTP 429 Too Many Requests error is returned. Requests succeed again after enough requests have emptied out of the bucket.

• DataGrail supports requests throttling to stay within 70-80% of specified service rate limits.
• DataGrail processes API responses with HTTP 429 status to interrupt requests, waiting and retrying (using an exponential backoff strategy).

---

Capabilities

Access

DataGrail's Crossbeam integration provides Synchronous Access capabilities for the following supported identifier category: Email.

Data Interactions

For Access requests, DataGrail will take the following actions:

1. Fetch all organizations.
2. Search persons by the configured identifiers.
3. Search account records by the configured identifiers.
4. Search partners by the configured identifiers.
5. Fetch partner details for all collected partners objects.

Endpoints Utilized

Method	Endpoint	Purpose	Docs
GET	/partner-records/people/record_id	Fetch partner details
GET	/partner-records/search	Search partner records
GET	/records/search	Search account records
GET	/search	Search persons
GET	/users/me	Fetch all organizations

---

System Detection

DataGrail provides continuous system detection, delivering a real-time inventory of your data assets.

Data Interactions

DataGrail's System Detection process runs once daily and performs the following actions:

1. Fetch all organizations.
2. Fetch all partners.
3. Select partner fields: domain, id, url, uuid, partnership_authorizer and users for analysis.

Endpoints Utilized

Method	Endpoint	Purpose	Docs
GET	/partners	Fetch all partners
GET	/users/me	Fetch all organizations

---