Breakcold integration
Connect a current Breakcold API key, choose least-privilege scopes, and validate it without spending tokens.
Oxygen connects to Breakcold's current v1 API as a BYOK integration. Use a personal API key whose value starts with bc_live_; legacy breakcold-usr... credentials do not authenticate against this API.
Connect safely
First inspect the requirement without supplying a credential:
oxygen integrations connect breakcold --jsonThe response is a preview: no API key is submitted, no provider call is made, and nothing is stored. It names the expected bc_live_... format and the setup location.
In Breakcold, open Settings → API keys, create a personal key, limit its workspace access, and grant only the scopes needed by the operations you plan to call. Then connect it:
oxygen integrations connect breakcold --api-key '<bc_live_...>' --jsonOxygen validates the submitted key with GET /workspaces before storing it. Breakcold prices that endpoint at zero tokens, it makes no CRM mutation, and Oxygen charges zero credits. A successful response identifies the authorized workspace and returns the Oxygen connection link.
Scope matrix
The validation call needs no additional Breakcold API scope. Tool calls need the scope shown in each oxygen tools get breakcold.<operation> --json descriptor.
| Work you want to do | Breakcold scopes |
|---|---|
| Inspect or change CRM objects and fields | crm:metadata:read, crm:metadata:write |
| Inspect or change inbox views | inbox:views:read, inbox:views:write |
| Read or write CRM records and custom activities | records:read, records:write |
| Read or write tasks | tasks:read, tasks:write |
| Read or write notes | notes:read, notes:write |
| Read conversations or send messages | inbox:read, inbox:send |
| Read meetings and transcripts | meetings:read |
| Manage integration hooks | webhooks:write |
Do not grant a write or send scope when the workspace only needs reads. Breakcold keys already carry their organization; the optional organization header is only for cases where Breakcold asks a signed-in user token to select one.
Discover and preview operations
oxygen tools search breakcold --json
oxygen tools get breakcold.workspaces_list --json
oxygen tools run breakcold.workspaces_list --mode dry-run --input-json '{"limit":1}' --jsonThe current catalog contains 64 Breakcold operations across workspaces, CRM schema and records, tasks, notes, inbox, meetings, and integration hooks. Most successful reads consume 0.2 Breakcold tokens and writes consume 0.4; these are Breakcold-account tokens, not Oxygen credits. Check the descriptor before each call for its exact token cost, scope, and side-effect class.
A tool dry run makes no provider call. Before a CRM write or message send, inspect the exact resource scope and preview, then provide the required approval for live execution.
Troubleshooting
- Legacy credential: If a value starts
breakcold-usr, create a newbc_live_...personal key in Breakcold Settings → API keys and reconnect. - No authorized workspace: Update the key's workspace limit in Breakcold, then reconnect.
- Stored-key test unsupported:
oxygen integrations test breakcold --jsoncurrently tells you to inspect the free connection preview and reconnect with a fresh credential. The preview command isoxygen integrations connect breakcold --json. - HTTP 412 from
/rest/me: That is Breakcold's deprecated API surface. Oxygen's current integration useshttps://rest.breakcold.com/api/v1with Bearer authentication instead.
Official references: Breakcold API overview and authentication.