HighLevel: Create new integration

← Payments operations · Get started

Operation gohighlevel.create_integration

Provider route: POST /payments/custom-provider/provider. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/gohighlevel with npm, or alter-sdk-gohighlevel with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { HighLevelIntegration } from "@alter-ai/gohighlevel";

async function execute(input: Parameters<HighLevelIntegration["payments"]["createIntegration"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new HighLevelIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.payments.createIntegration(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_gohighlevel import HighLevelIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = HighLevelIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.payments.create_integration(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
query	object	Required within parent	Additional keys: not allowed
query.locationId	string	Required within parent
body	Model	Required within parent	Expand Create new integration — request body — body

Referenced models: Create new integration — request body — body

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	Model	Root	Expand Create new integration — response body

Referenced models: Create new integration — response body

Schemas

Create new integration — response body

Field	Type	Presence	Description and constraints
$	object	Root
_id	string	Required within parent	The unique identifier for the custom provider.
createdAt	string	Required within parent	The creation timestamp of the custom provider. Format: date-time
deleted	boolean	Required within parent	Whether the config is deleted or not. true represents config is deleted
description	string	Required within parent	Description of payment gateway. Shown on the payments integrations page as subtext
imageUrl	string	Required within parent	Public image url for logo of the payment gateway displayed on the payments integrations page.
locationId	string	Required within parent	Location id
marketplaceAppId	string	Required within parent	The application id of marketplace
name	string	Required within parent	The name of the custom provider
paymentProvider	object	Optional	Payment provider details.
paymentsUrl	string	Required within parent	This url will be loaded in iFrame to start a payment session.
queryUrl	string	Required within parent	The url used for querying payments related events. Ex. verify, refund, subscription etc.
traceId	string	Optional	Trace id of the custom provider.
updatedAt	string	Required within parent	The last update timestamp of the custom provider. Format: date-time

Create new integration — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
description	string	Required within parent	Description of payment gateway. Shown on the payments integrations page as subtext
imageUrl	string	Required within parent	Public image url for logo of the payment gateway displayed on the payments integrations page.
name	string	Required within parent	The name of the custom provider
paymentsUrl	string	Required within parent	This url will be loaded in iFrame to start a payment session.
queryUrl	string	Required within parent	The url used for querying payments related events. Ex. verify, refund, subscription etc.
supportsSubscriptionSchedule	boolean	Required within parent	Whether the config supports subscription schedule or not. true represents config supports subscription schedule

Policy, approvals and errors

SDK function policy ID: gohighlevel.create_integration. Catalog operation: create-integration. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Required provider scopes: ["payments/custom-provider.write"]

Pinned headers: {"Version": "v3"}

Official provider source