Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.breakcold.com/llms.txt

Use this file to discover all available pages before exploring further.

The Breakcold Public API is available under /api/v1 on your Breakcold API base URL. Use the API for records, tasks, notes, and basic inbox workflows. Permanent record deletion is intentionally not part of v1; archive and restore are available instead.

​
Webhooks

Breakcold can send outbound webhooks when records, notes, tasks, relations, calls, or files change in your workspace. See Webhooks for delivery headers, signature verification, event types, and payload examples.

​
Choose your region

Pick the API URL for the region where your Breakcold workspace is hosted.
Use this URL if your Breakcold workspace is hosted in the United States.
https://http.us.breakcold.com/api/v1
The API contract is generated from packages/backend/convex/public_api/contract.ts.