Skip to main content

API First

info

As a core engineering principle, epilot designs API contracts before implementation.

All APIs are defined using machine-readable standards:

Public API​

All core APIs are public. Partners and customers use them to build integrations and extend the platform.

Browse the API Reference API Changelog

Webhooks & Event Schemas​

epilot publishes platform events through Webhooks, enabling real-time push notifications to external systems. Events follow a standardized schema defined in Core Events, covering entity lifecycle changes, workflow transitions, portal actions, and more.

Webhooks are the primary mechanism for outbound integrations — ERPs, middleware, and third-party systems subscribe to the events they care about and receive structured payloads as they happen. See Payload Structure for format details and Security for signature verification.

Accessing APIs with MCP​

tip

Developers using LLM clients (Claude Desktop, Cursor, etc.) can explore epilot APIs interactively through the MCP server — no manual API doc browsing required.

Setup​

Add this to your MCP client configuration (see MCP setup guide):

MCP client config
{
  "mcpServers": {
    "epilot-openapi": {
      "command": "npx",
      "args": ["-y", "openapi-analyzer-mcp"],
      "env": {
        "OPENAPI_DISCOVERY_URL": "https://docs.epilot.io/openapi-specs/apis.json"
      }
    }
  }
}

Usage​

Once configured, you can:

  • Query available endpoints and schemas
  • Explore request/response formats interactively
  • Generate code examples for specific endpoints