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

    Interface BondiModuleOptions

    Options for BondiModule.forRoot. The integration metadata is required; everything else falls back to environment variables.

    interface BondiModuleOptions {
        apiUrl?: BondiConfigValue;
        integration: { category: string; name: string; slug: string };
        internalApiKey?: BondiConfigValue;
        internalMode?: boolean;
        token?: BondiConfigValue;
        triggers?: Type<BondiTriggerBase<ZodTypeAny>>[];
        workspaceId?: BondiConfigValue;
    }
    Index

    Properties

    apiUrl? integration internalApiKey? internalMode? token? triggers? workspaceId?

    Properties

    apiUrl?: BondiConfigValue

    Bondi automation API URL. Defaults to process.env.BONDI_API_URL; if that is also unset, BondiClient falls back to https://automation.heybondi.com. Set explicitly only when targeting a non-prod Bondi deployment. Required when internalMode: true (otherwise the client falls into dry-run instead of posting to the public endpoint). Accepts a string, { envKey: "..." }, or factory () => string | undefined.

    integration: { category: string; name: string; slug: string }

    Integration metadata. The slug must match the slug used in npx bondi init so emits and actions resolve to the right provider.

    Type Declaration

    • category: string

      Category bucket (e.g. "crm", "billing").

    • name: string

      Display name shown in the Bondi Studio.

    • slug: string

      URL-safe identifier; matches what bondi init registered.

    internalApiKey?: BondiConfigValue

    Internal API key (for internalMode: true). Defaults to process.env.INTERNAL_API_KEY.

    internalMode?: boolean

    Internal mode: post platform events to /internal/platform-events with INTERNAL_API_KEY. Set to true ONLY in Bondi's own NestJS app (dogfood).

    token?: BondiConfigValue

    Integration token. Defaults to process.env.BONDI_INTEGRATION_TOKEN. Same forms as BondiModuleOptions.apiUrl.

    triggers?: Type<BondiTriggerBase<ZodTypeAny>>[]

    Trigger classes to register as DI providers. Each must extend BondiTriggerBase and be decorated with @BondiTrigger.

    workspaceId?: BondiConfigValue

    Workspace ID. Defaults to process.env.BONDI_WORKSPACE_ID. Same forms as BondiModuleOptions.apiUrl.

    Settings

    Member Visibility

    On This Page

    Properties