> For the complete documentation index, see [llms.txt](https://docs.startdeliver.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.startdeliver.io/integrations-and-your-stack/api-and-custom-integrations.md). # API & custom integrations **Where to find it:** Apps → Developer portal · app.startdeliver.com/dev **Who can access it:** Developers and technical admins *** **What it is** Startdeliver provides a fully-featured REST API that covers every core object in the platform. If your tool isn't in the app marketplace, or you need a custom data flow that a native integration doesn't support, the API gives you full programmatic access to build exactly what you need. The API is also how your product sends usage events to Startdeliver — the raw signals that feed product usage health and the AI assessment. This is one of the most important integrations for any Startdeliver customer, because product usage data is central to how the AI understands and assesses each customer. *** **What the API covers** The Startdeliver API supports read and write operations across all core platform objects: * **Customer** — create, update, and read customer records * **User** — sync users from your product or CRM * **Team member** — manage team member records programmatically * **Project** — create and update projects on customer records * **Task** — create, assign, and complete tasks * **Custom field** — read and write custom field values * **Usage** — send product usage events from your platform * **Support** — sync support ticket data from custom sources * **Feedback** — send survey and feedback data from custom sources * **File** — attach files to customer records * **Product** — manage product definitions * **Usage type** — define and manage usage event types * **Customer status** — read and update lifecycle stage *** **Usage events — the most important integration** Usage events are how your product tells Startdeliver what your customers are doing. Every feature interaction, login, or custom event your product tracks can be sent to Startdeliver via the Usage API or the JavaScript library. Once usage events are flowing, Startdeliver maps them to products and usage types, calculates health per product per customer, and feeds that signal into the AI assessment. This is what makes the health model specific to how your customers actually use your product — not a generic engagement score. **Two ways to send usage events:** **JavaScript library** — for web applications. Include the Startdeliver JS library in your front end and send usage events directly from the browser as users interact with your product. **Usage API** — for server-side event tracking. Send events via HTTP from your backend whenever a usage event occurs. → [Full usage event documentation](https://app.startdeliver.com/dev) *** **Building a custom integration** If your tool isn't in the Startdeliver app marketplace, you can build a custom connector using the API. Common use cases: * Syncing customers and users from a proprietary system * Sending usage data from a product built on a custom analytics stack * Pulling Startdeliver health data into an internal BI tool or data warehouse * Pushing customer data from Startdeliver into a custom CRM or ERP The API uses standard REST conventions with JSON responses. Authentication is via API key. Full reference documentation, guides, and code examples are in the developer portal. → [Open developer portal](https://app.startdeliver.com/dev) *** **Webhooks** Startdeliver supports webhooks for real-time event handling. Subscribe to events — customer created, health status changed, task completed, and more — and receive a HTTP POST to your endpoint the moment something happens. Useful for keeping external systems in sync without polling. → [Webhook documentation](https://app.startdeliver.com/dev) *** **MCP server** If you want an AI tool to work directly in Startdeliver, use the MCP server. Supported tools can read customers, tasks, and projects, then act within granted permissions. → [MCP server guide](https://app.startdeliver.com/dev/tutorial/mcp-server) → [MCP - Model Context Protocol](/jecta-agent-and-ai/mcp-model-context-protocol.md) *** **Building and publishing apps** The Startdeliver App Directory lets you build apps that extend the platform for your own use or distribute to other Startdeliver customers. If you've built a connector your customers could benefit from, you can publish it in the marketplace. → [App Directory](https://app.startdeliver.com/apps) → [Developer portal](https://app.startdeliver.com/dev) *** **Getting started** The fastest path to your first API integration: 1. Go to the [developer portal](https://app.startdeliver.com/dev) and read the overview 2. Generate your API key in Settings → Security 3. Follow the relevant guide — Sync customers and users, Start sending usage, or Check out the API 4. Test with the interactive API reference before building in production --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://docs.startdeliver.io/integrations-and-your-stack/api-and-custom-integrations.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.