For the complete documentation index, see llms.txt. This page is also available as Markdown.

API & custom integrations

Startdeliver provides a full REST API, usage event tracking, webhook support, and MCP — everything your technical team needs to connect Startdeliver to your stack.

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


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


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


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 guideMCP - Model Context Protocol


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 DirectoryDeveloper portal


Getting started

The fastest path to your first API integration:

  1. Go to the developer portal 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

Last updated

Was this helpful?