@squidcloud/backend
    Preparing search index...

    Interface CallApiRequest<BodyType>

    Represents a request to call an API through a specified integration and endpoint. Includes optional method override and additional request options.

    interface CallApiRequest<BodyType = any> {
        body?: BodyType;
        endpointId: string;
        integrationId: string;
        options: ApiOptions;
        overrideMethod?: HttpMethod;
    }

    Type Parameters

    • BodyType = any
    Index

    Properties

    body? endpointId integrationId options overrideMethod?

    Properties

    Optionalbody

    body?: BodyType

    Optional request payload.

    endpointId: string

    Target API endpoint to invoke.

    integrationId: string

    The identifier of the integration through which the API is called.

    options: ApiOptions

    Additional request options.

    overrideMethod?: HttpMethod

    Optional HTTP method override. Default is POST.

    Settings

    Member Visibility

    On This Page

    Properties