@bondi-labs/integration-sdk - v0.0.2
    Preparing search index...

    Interface IntegrationDefinition

    The top-level integration descriptor returned by defineIntegration. Sync this to Bondi via npx bondi sync (CLI) or client.register() (programmatic).

    interface IntegrationDefinition {
        apiVersion?: string;
        baseUrl: string;
        category: string;
        description?: string;
        iconUrl?: string;
        name: string;
        services: ServiceDefinition[];
        slug: string;
        version?: string;
    }
    Index

    Properties

    apiVersion? baseUrl category description? iconUrl? name services slug version?

    Properties

    apiVersion?: string

    Optional API version label (e.g. "v1") — informational.

    baseUrl: string

    Base URL Bondi prepends to every action endpoint.

    category: string

    Category bucket in the integrations directory (e.g. "crm", "billing").

    description?: string

    Optional longer description shown on the integration's detail page.

    iconUrl?: string

    Public icon URL (PNG/SVG, square recommended).

    name: string

    Display name shown in the Bondi Studio.

    services: ServiceDefinition[]

    Services grouping the integration's actions and triggers.

    slug: string

    URL-safe identifier — must match the slug used in npx bondi init.

    version?: string

    Optional package version (e.g. "1.2.0") — included in sync metadata.

    Settings

    Member Visibility

    On This Page

    Properties