@makehq/sdk
    Preparing search index...

    Class Make

    The main Make SDK class that provides access to all Make API endpoints. Acts as the entry point for interacting with the Make API.

    Index

    Constructors

    constructor

    Properties

    blueprints connections dataStores dataStructures enums executions folders functions hooks incompleteExecutions keys organizations protocol scenarios sdk teams users version zone

    Methods

    fetch handleError handleRequest handleResponse prepareBody prepareHeaders prepareQuery prepareURL

    Constructors

    • Create a new Make SDK instance

      Parameters

      • token: string

        Your Make API key or OAuth2 access token

      • zone: string

        The Make zone (e.g. eu1.make.com)

      • options: { headers?: Record<string, string>; version?: number } = {}

        Optional configuration

        • Optionalheaders?: Record<string, string>

          Custom headers to include in all requests

        • Optionalversion?: number

          API version to use (defaults to 2)

      Returns Make

    Properties

    blueprints: Blueprints

    Access to blueprint-related endpoints Blueprints define the structure and workflow of scenarios

    connections: Connections

    Access to connection-related endpoints Connections link Make to external apps and services

    dataStores: DataStores

    Access to data store-related endpoints Data stores allow you to store and retrieve data within Make

    dataStructures: DataStructures

    Access to data structure-related endpoints Data structures define the structure of data being used in Make

    enums: Enums

    Access to enum-related endpoints Enums provide access to standardized lists like countries, regions, and timezones

    executions: Executions

    Access to execution-related endpoints Executions represent the running instances of scenarios

    folders: Folders

    Access to folder-related endpoints Folders help organize scenarios

    functions: Functions

    Access to function-related endpoints Functions are custom code snippets that can be used in scenarios

    hooks: Hooks

    Access to webhook-related endpoints Hooks (webhooks and mailhooks) notify you when certain changes occur in connected apps or services

    incompleteExecutions: IncompleteExecutions

    Access to incomplete execution-related endpoints Incomplete executions are scenario runs that didn't complete successfully

    keys: Keys

    Access to key-related endpoints Keys store secrets that can be used in apps

    organizations: Organizations

    Access to organization-related endpoints Organizations are top-level entities that contain teams and manage overall account settings

    protocol: string

    The protocol to use (defaults to https) Can be changed to http for testing in local environments

    scenarios: Scenarios

    Access to scenario-related endpoints Scenarios allow you to create and run automation tasks

    sdk: {
        apps: SDKApps;
        connections: SDKConnections;
        functions: SDKFunctions;
        modules: SDKModules;
        rpcs: SDKRPCs;
        webhooks: SDKWebhooks;
    }

    Access to SDK-related endpoints

    Type declaration

    • Readonlyapps: SDKApps

      Access to App-related endpoints Apps allow you to create and manage custom applications for Make

    • Readonlyconnections: SDKConnections

      Access to Connection-related endpoints Connections manage authentication and authorization for apps

    • Readonlyfunctions: SDKFunctions

      Access to Function-related endpoints Functions are reusable code blocks within apps

    • Readonlymodules: SDKModules

      Access to Module-related endpoints Modules are the building blocks of apps

    • Readonlyrpcs: SDKRPCs

      Access to RPC-related endpoints RPCs are the building blocks of apps

    • Readonlywebhooks: SDKWebhooks

      Access to Webhook-related endpoints Webhooks are used to listen for external events in apps

    teams: Teams

    Access to team-related endpoints Teams control access to Make scenarios, connections, data stores, and other resources

    users: Users

    Access to user-related endpoints Provides methods to get current user information

    version: number

    The API version to use Default is version 2 of the Make API

    zone: string

    The Make zone (e.g. eu1.make.com) Identifies the region of the Make servers to connect to

    Methods

    • Internal

      Make API requests with authentication

      Handles URL construction, authentication, and error handling for all API calls. This method is used internally by all endpoint classes.

      Type Parameters

      • T = unknown

        The expected response type

      Parameters

      • url: string

        The endpoint URL (relative or absolute)

      • Optionaloptions: FetchOptions

        Request options (method, headers, body, query parameters)

      Returns Promise<T>

      Promise resolving to the parsed response data

      If the API returns an error response

    • Protected

      Handle API error responses

      Converts error responses into MakeError instances with proper error details. This method processes the response body to extract error information.

      Parameters

      • response: Response

        The error response from the API

      Returns Promise<MakeError>

      Promise resolving to a MakeError instance

    • Protected

      Execute the HTTP request

      Makes the actual fetch request with the provided URL and options. This method can be overridden in subclasses for custom request handling.

      Parameters

      • url: string

        The complete URL to request

      • Optionaloptions: RequestInit

        Fetch options including headers, body, and method

      Returns Promise<Response>

      Promise resolving to the Response object

    • Protected

      Handle successful API responses

      Parses the response based on content-type header. JSON responses are parsed as objects, other responses as text.

      Type Parameters

      • T

        The expected response type

      Parameters

      • response: Response

        The successful response from the API

      Returns Promise<T>

      Promise resolving to the parsed response data

    • Protected

      Prepare the request body for API calls

      Parameters

      • body: undefined | string | Record<string, JSONValue> | JSONValue[]

        The request body - can be an object, string, or undefined

      • headers: Record<string, string>

        The headers object to potentially modify the content-type

      Returns string

      The body serialized as a string

    • Protected

      Prepare headers for API requests

      Parameters

      • Optionalheaders: Record<string, string>

        Request-specific headers to prepare

      Returns Record<string, string>

      Headers object ready for the request

    • Protected

      Add query parameters to a URL

      Parameters

      • url: string

        The base URL

      • Optionalquery: Record<string, QueryValue>

        Query parameters to append

      Returns string

      The URL with query parameters appended

    • Protected

      Prepare the full URL for API requests

      Parameters

      • url: string

        The URL - can be relative or absolute

      • Optionalquery: Record<string, QueryValue>

        Query parameters to append

      Returns string

      The complete URL ready for the request

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods