Teams that want to build on top of Collabre use the REST API and webhooks. This page covers the parts that do not change from endpoint to endpoint.
Which plans include API access
API keys are included on the Elite plan and on Enterprise agreements. The other paid plans cover the product itself and the integrations listed on the integrations page, which cover most teams without any code. Compare what each plan includes on /pricing, and see Billing and plans.
If you are on another plan and need programmatic access, write to us and we will tell you what the move involves.
Creating a key
An Owner or Admin creates an API key from the Workspace settings. Name the key after the system that will use it, so an unused key can be identified and revoked later without guesswork.
The secret is shown once, at creation. Store it where your other service credentials live, never in a repository or a shared document. Create one key per consuming system rather than sharing a single key, because that is what makes revocation safe.
Revoke a key from the same screen. Revocation takes effect immediately, and the calls made with the key stay in the audit log.
Scopes
A key carries scopes, and a scope decides which parts of the Workspace the key can read or change. Grant the narrowest set the calling system actually needs. A key that only reports on performance does not need permission to publish, and a key that schedules posts does not need access to billing.
Scopes are chosen at creation and are visible on the key afterwards, so a review of your keys is a review of what each system can do.
Rate limits
Calls are rate limited per key. When a client exceeds its limit, the API refuses the call rather than queueing it, so design the client to back off and retry rather than to hammer. Batch where an endpoint supports it, cache what does not change between calls, and schedule bulk work outside the hours your team is publishing.
Webhooks
Webhooks send Collabre events to a URL you control, so a system you already run can react to what happens here rather than polling for it.
Register the destination URL, choose the events it should receive, and verify the delivery from your side before you depend on it. Your endpoint should answer quickly and do its real work afterwards, treat a repeated delivery of the same event as harmless, and log what it received so a missed event can be reconstructed.
The endpoint reference
The reference for individual endpoints is published in this section as each area is documented, alongside the pages you are reading now. Until the area you need appears here, write to us and tell us which objects you are working with. We would rather answer directly than have you guess at a shape.
Agents can call your API too
An Agent can be given a custom HTTP tool pointing at your internal API, with domain allow listing and credentials held in a secrets vault rather than pasted into a prompt. Upload an API specification and Collabre generates the tools from it. See The AI workforce.