HubSpot: Retrieve subscriptions

HubSpot ipRanges.getWebhookSubscriptionsByAppId: arguments, response, policy and SDK examples.

Operation hubspot.ip_ranges_get_webhook_subscriptions_by_app_id

Provider route: GET /meta/network-origins/2026-09/ip-ranges/webhook-subscriptions/{appId}. Alter supplies the connection’s credentials and routing.

Call through Alter

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

import { App } from "@alter-ai/sdk";
import { HubSpotIntegration } from "@alter-ai/hubspot";

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

import os
from alter_sdk import App
from alter_sdk_hubspot import HubSpotIntegration

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

Input

Field	Type	Presence	Description and constraints
`$`	object	Root	Additional keys: not allowed
`path`	object	Required within parent	Additional keys: not allowed
`path.appId`	string	Required within parent	Pattern: .+

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 Retrieve subscriptions — response body

Referenced models: Retrieve subscriptions — response body

Schemas

Retrieve subscriptions — response body

Field	Type	Presence	Description and constraints
`$`	object	Root
`results`	array	Required within parent	An array of webhook subscriptions. Each item in the array is a WebhookSubscription object.
`results[]`	Model	Each item	Expand Create webhook subscription — response body

Referenced models: Create webhook subscription — response body

Create webhook subscription — response body

Field	Type	Presence	Description and constraints
`$`	object	Root
`appId`	JSON	Required within parent
`appId (anyOf 1)`	integer	Alternative	The unique identifier of the application that owns the webhook subscription. It is an integer. Format: int32
`appId (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`createdAt`	JSON	Required within parent
`createdAt (anyOf 1)`	integer	Alternative	The timestamp when the webhook subscription was created, represented as an integer in int64 format. Format: int64
`createdAt (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`createdByUserId`	JSON	Optional
`createdByUserId (anyOf 1)`	integer	Alternative	The unique identifier of the user who created the webhook subscription. It is an integer. Format: int32
`createdByUserId (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`id`	JSON	Required within parent
`id (anyOf 1)`	integer	Alternative	The unique identifier of the webhook subscription. It is an integer formatted as int64. Format: int64
`id (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`portalId`	JSON	Required within parent
`portalId (anyOf 1)`	integer	Alternative	The unique identifier of the HubSpot portal associated with the webhook subscription. It is an integer. Format: int32
`portalId (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`updatedAt`	JSON	Required within parent
`updatedAt (anyOf 1)`	integer	Alternative	The timestamp when the webhook subscription was last updated, represented as an integer in int64 format. Format: int64
`updatedAt (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`webhookUrl`	string	Required within parent	The URL to which the webhook events will be sent. It is a string.

Policy, approvals and errors

SDK function policy ID: hubspot.ip_ranges_get_webhook_subscriptions_by_app_id. Catalog operation: ip_ranges_get_webhook_subscriptions_by_app_id. 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: ["origins.ip_ranges.webhook.read", "origins.ip_ranges.webhook.write"]

Official provider source

Report an issue with this page