Getting Started
Overview
What ComeBk is, who it serves, and how this documentation is organised.
ReadComeBk
Documentation
Onboarding, guides, API reference, FAQ, and release notes for implementing ComeBk.
Documentation is the primary path for onboarding, implementation, reference, and troubleshooting ComeBk.
Start with Getting Started, then use Guides for workflows, API for clients, FAQ for common questions, and Release Notes when upgrading.
Getting Started
Install, verify connectivity, and learn core vocabulary before deeper guides.
4 published entries
Getting Started
Installation
Prerequisites and steps to install a ComeBk environment for development or evaluation.
ReadGetting Started
Quick start
Create a minimal opportunity cycle and confirm read/write path against the ComeBk API.
ReadGetting Started
Core concepts
Vocabulary for cycles, channels, opportunities, and explainability in ComeBk.
ReadDocumentation categories
Browse by collection. Each category links to its full index.
4 entries
Getting Started
Install, verify connectivity, and learn core vocabulary before deeper guides.
3 entries
Guides
Task-oriented how-tos for opportunities, cycles, channels, and CRM mirrors.
1 entry
API
HTTP surface, authentication, errors, and versioning for client integrations.
1 entry
FAQ
Short answers to common product and operations questions.
3 entries
Release Notes
What changed by version — upgrade notes and breaking changes.
Popular documentation
Representative published entries from the documentation catalogs.
Getting Started
Quick start
Create a minimal opportunity cycle and confirm read/write path against the ComeBk API.
ReadGetting Started
Core concepts
Vocabulary for cycles, channels, opportunities, and explainability in ComeBk.
ReadGuides
Working with opportunities
Create, advance, and query opportunities across cycle stages.
ReadGuides
Configuring cycles and channels
Define tenant cycle stages and channel taxonomies used across opportunities and reporting.
ReadAPI overview
The ComeBk HTTP API is tenant-scoped under `/v1`. Clients authenticate with bearer tokens and may request explanations on opportunity reads.
Use the API collection for authentication, resource paths, errors, and versioning. This section is an introduction only.
Latest updates
Recent entries from the Release Notes collection.
Release Notes
v0.3.0
Admin cycle and channel writes, deployment hardening, and documentation catalog expansion.
ReadRelease Notes
v0.2.0
Stage advancement, explainability includes, and webhook delivery for opportunity updates.
ReadRelease Notes
v0.1.0
Initial public API surface for opportunities, authentication, and tenant configuration.
ReadResources
Implementation resources related to documentation topics.
Need help
If documentation does not answer your question, continue to Contact, Product, Pricing, or Resources.