In this article:
Overview
The API page brings together everything your engineering or web ops team uses to connect to Crossbeam programmatically. To open it, go to Data > API.
The page has four tabs:
Tab | What it's for | Learn more |
Webhooks | Crossbeam notifies your system when partner activity happens, such as a partner opening or winning a deal on a mutual account | |
API Integrations | Your own app or tool connects to Crossbeam securely | |
API Filters | Limit which overlap records the API sends you | API Filters below |
API Keys | Credentials your systems use to connect to Crossbeam | API Keys below |
✍️ Note
Webhooks and API integrations used to live on the Integrations page. They work the same way; only their location changed. Push integrations, such as Salesforce and HubSpot custom objects, stay on the Integrations page.
Plan Availability and Access
The API page is available on Supernode and Enterprise plans
Webhooks are available on the Enterprise plan
Only admins with a Full Access seat can view and manage the API page
To upgrade, visit the Plan & Billing page.
Webhooks
A webhook lets Crossbeam notify your system as soon as something happens, so your system doesn't have to keep checking.
Create a webhook: open the Webhooks tab and click Create Webhook
Edit a webhook: open the Webhooks tab and click Settings next to the webhook
For event types, testing, and filters, see Getting Started with Signals.
To send Net New Accounts through a webhook, see Net New Accounts in Pipeline Generation.
API Integrations
An API integration lets your own app or tool connect to Crossbeam securely.
Open the API Integrations tab and click Create Integration.
Fill in the fields:
Integration name: anything that identifies the app to you
Integration description: optional, 140 characters max
Callback URL: the URL or URLs your application can redirect to after authentication
Allowed Origins: optional. The domains your application sends requests from. If left blank, requests from all origins are allowed.
Click Create Integration. Your client ID and client secret are in the integration's Settings.
For authentication and endpoints, see the Crossbeam Developer Documentation.
API Filters
Without a filter, the API sends every overlap record your partners share with you, and each record sent counts toward your Record Export limit. API filters let you tell Crossbeam up front which records you want.
Records that don't match a filter are never sent and don't count toward your Record Export limit.
Create an API filter
Open the API Filters tab and click Create Filter.
Enter a name for the filter.
Under Your Populations, select which of your Populations to include. You can include Standard and Custom Populations.
Under Partner Populations, choose which partner Populations to include. The default settings apply to all partners. To get more specific, select individual partners and their Populations.
Click Save Settings.
To edit or delete a filter, return to the API Filters tab and click Settings.
Use a filter in an API request
Each filter has an ID you can copy from the API Filters tab. Your engineering team adds this ID to their API requests, and Crossbeam only returns the records that match. See the Developer Documentation for the request parameter.
Good to know
Up to 5 filters per organization.
Reuse a filter anywhere. One filter can be used across multiple tools or scripts. If you edit a filter, the change applies everywhere it's used.
New filters need a little time. Crossbeam prepares the data before a new filter can be used.
Overlap data only. Filters apply to account and opportunity overlaps. They don't apply to webhooks or other API endpoints yet.
No record preview. There's no preview of how many records a filter will return.
API Keys
An API key works like a key card: it lets one of your systems connect to Crossbeam on your behalf. Give each system its own key, control what it can access, and turn one off without affecting the others.
Create an API key
Open the API Keys tab and click Create API Key.
Set up the key:
Name: so you know which system uses it
Scopes: what the key can access. See the Developer Documentation for available scopes.
Allowed IPs: optional. Where the key can be used from.
Expiration date: optional
Click Create, then copy the key and store it somewhere secure.
To edit or delete a key, return to the API Keys tab and click Settings.
Monitor keys and usage
For each key, the API Keys tab shows when it was last used and who created it. You can also see how much of today's request limit your organization has used.
API keys have a requests-per-minute limit and a daily limit. See the Developer Documentation for current limits.
Limits are shared across your organization. Creating more keys doesn't add capacity.
Replace a key without downtime
Create a new key.
Update your system to use the new key.
Revoke the old key.
Revoking the old key first breaks the integration until the new key is in place.
FAQ
Where did webhooks and API integrations go?
They moved from the Integrations page to the API page. Existing webhooks and integrations keep working.
Do API calls count toward my Record Export limit?
Yes. Every overlap record sent through the API counts. Use an API filter so only the records you need are sent.
Do API filters work with webhooks?
Not yet. Webhooks have their own Population filters, set when you create the webhook.
Does creating more API keys raise my limits?
No. Request limits are shared across your organization.
📄 Related Articles