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

    Interface SerializedIntegration

    Final wire format sent to Bondi by register() / sync. Zod schemas are pre-converted to JSON Schema so the backend doesn't need a Zod runtime.

    Customers normally don't construct this directly — serializeIntegration() produces it from an IntegrationDefinition.

    interface SerializedIntegration {
        apiVersion?: string;
        baseUrl: string;
        category: string;
        configSchema: { properties: Record<string, unknown>; type: "object" };
        description?: string;
        iconUrl?: string;
        name: string;
        services: {
            actions: {
                bodySchema?: unknown;
                description?: string;
                endpoint: string;
                headersSchema?: unknown;
                httpMethod: HttpMethod;
                label: string;
                name: string;
                queryParamsSchema?: unknown;
                responseSchema?: unknown;
                type: "rest_api";
            }[];
            description?: string;
            label: string;
            name: string;
            webhookConfig?: {
                availableEvents: {
                    description?: string;
                    label: string;
                    name: string;
                    payloadSchema?: unknown;
                }[];
            };
        }[];
        slug: string;
        version?: string;
    }
    Index

    Properties

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

    Properties

    apiVersion?: string

    IntegrationDefinition.apiVersion

    baseUrl: string

    IntegrationDefinition.baseUrl

    category: string

    IntegrationDefinition.category

    configSchema: { properties: Record<string, unknown>; type: "object" }

    Reserved for connection-time inputs (currently empty for custom integrations).

    Type Declaration

    • properties: Record<string, unknown>

      Zero or more JSON-Schema-compatible config fields.

    • type: "object"

      Always "object" — JSON Schema compatible.

    description?: string

    IntegrationDefinition.description

    iconUrl?: string

    IntegrationDefinition.iconUrl

    name: string

    IntegrationDefinition.name

    services: {
        actions: {
            bodySchema?: unknown;
            description?: string;
            endpoint: string;
            headersSchema?: unknown;
            httpMethod: HttpMethod;
            label: string;
            name: string;
            queryParamsSchema?: unknown;
            responseSchema?: unknown;
            type: "rest_api";
        }[];
        description?: string;
        label: string;
        name: string;
        webhookConfig?: {
            availableEvents: {
                description?: string;
                label: string;
                name: string;
                payloadSchema?: unknown;
            }[];
        };
    }[]

    Services with all Zod schemas converted to JSON Schema.

    Type Declaration

    • actions: {
          bodySchema?: unknown;
          description?: string;
          endpoint: string;
          headersSchema?: unknown;
          httpMethod: HttpMethod;
          label: string;
          name: string;
          queryParamsSchema?: unknown;
          responseSchema?: unknown;
          type: "rest_api";
      }[]

      Action definitions with serialized JSON schemas.

    • Optionaldescription?: string

      ServiceDefinition.description

    • label: string

      ServiceDefinition.label

    • name: string

      ServiceDefinition.name

    • OptionalwebhookConfig?: {
          availableEvents: {
              description?: string;
              label: string;
              name: string;
              payloadSchema?: unknown;
          }[];
      }

      Trigger / webhook event metadata for this service.

      • availableEvents: { description?: string; label: string; name: string; payloadSchema?: unknown }[]

        Events the integration can emit.

    slug: string

    IntegrationDefinition.slug

    version?: string

    IntegrationDefinition.version

    Settings

    Member Visibility

    On This Page

    Properties