Skip to main content

Get Integration Resource

Fetch the resource and operation schema for a specific integration. This tells you which resources (e.g., "project", "task", "contact") are available and what operations can be performed on each.

Function Signature​

client.workflow.getIntegrationResource(params: GetIntegrationResourceParams): Promise<BolticSuccessResponse<IntegrationResourceData> | BolticErrorResponse>

Parameters​

ParameterTypeRequiredDescription
integration_slugstring✅Integration identifier (e.g., "blt-int.asana")

Basic Usage​

import { createClient } from "@boltic/sdk";

const client = createClient("your-api-key");

const result = await client.workflow.getIntegrationResource({
    integration_slug: "blt-int.asana",
});

if (result.error) {
    console.error("Failed:", result.error.message);
} else {
    console.log("Resources & operations:", result.data);
}

Discovering Resources​

Use the resource schema to discover what an integration supports before building activity payloads:

const schema = await client.workflow.getIntegrationResource({
    integration_slug: "blt-int.freshsales",
});

if (!schema.error) {
    // Inspect available resources and their operations
    console.log("Available resources:", JSON.stringify(schema.data, null, 2));

    // Use this information to build executeIntegration calls
    // or to fetch form schemas with getIntegrationForm
}

Return Value​

Success Response​

{
    data: {
        // Resource/operation schema — structure varies by integration
        [key: string]: unknown;
    },
    message?: string;
}