Skip to content

HubSpot: Find Marketing Events by External Event Id

HubSpot marketingEvents.identifiersGetMarketingEventsExternalid: arguments, response, policy and SDK examples.

← Marketing events operations · Get started

Operation hubspot.marketing_events_identifiers_get_marketing_events_externalid

Provider route: GET /marketing/marketing-events/2026-09/{externalEventId}/identifiers. Alter supplies the connection’s credentials and routing.

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["marketingEvents"]["identifiersGetMarketingEventsExternalid"]>[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.marketingEvents.identifiersGetMarketingEventsExternalid(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.marketing_events.identifiers_get_marketing_events_externalid(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.externalEventIdstringRequired within parent

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

FieldTypePresenceDescription and constraints
$ModelRootExpand Find Marketing Events by External Event Id — response body

Referenced models: Find Marketing Events by External Event Id — response body

Find Marketing Events by External Event Id — response body
FieldTypePresenceDescription and constraints
$objectRoot
pagingModelOptionalExpand Find Marketing Events by External Event Id — response body — paging
resultsarrayRequired within parentAn array containing the marketing event identifiers. Each item in the array is a MarketingEventIdentifiersResponse object.
results[]ModelEach itemExpand Find Marketing Events by External Event Id — response body — results item
totalJSONRequired within parent
total (anyOf 1)integerAlternativeAn integer representing the total number of marketing event identifiers.
Format: int32
total (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: Find Marketing Events by External Event Id — response body — results item, Find Marketing Events by External Event Id — response body — paging

Find Marketing Events by External Event Id — response body — results item
FieldTypePresenceDescription and constraints
$objectRoot
appInfoModelOptionalExpand Get Marketing Event by object Id — response body — app Info
externalAccountIdstringOptionalThe accountId that is associated with this marketing event in the external event application
externalEventIdstringRequired within parentThe ID that is associated with this marketing event in the external event application
marketingEventNamestringRequired within parentThe name of the marketing event
objectIdstringRequired within parentThe internal ID of the marketing event in HubSpot CRM

Referenced models: Get Marketing Event by object Id — response body — app Info

Find Marketing Events by External Event Id — response body — paging
FieldTypePresenceDescription and constraints
$objectRootRepresents the pagination information for navigating through a list of results in the API. It provides details on how to access the previous or next set of results.
nextModelOptionalExpand List — marketing Events get Marketing Events — response body — paging next
prevModelOptionalExpand Find Marketing Events by External Event Id — response body — paging prev

Referenced models: List — marketing Events get Marketing Events — response body — paging next, Find Marketing Events by External Event Id — response body — paging prev

Get Marketing Event by object Id — response body — app Info
FieldTypePresenceDescription and constraints
$objectRoot
idstringRequired within parentThe ID of the application
namestringRequired within parentThe name of the application
List — marketing Events get Marketing Events — response body — paging next
FieldTypePresenceDescription and constraints
$objectRootSpecifies the paging information needed to retrieve the next set of results in a paginated API response
afterstringRequired within parentThe ID element at the start of the page
linkstringOptionalLink to the next page
Find Marketing Events by External Event Id — response body — paging prev
FieldTypePresenceDescription and constraints
$objectRootspecifies the paging information needed to retrieve the previous set of results in a paginated API response
beforestringRequired within parentA string that serves as a cursor indicating the position before the first item in the current set of results, used to fetch the previous set of results.
linkstringOptionalA string containing the URL link to the previous page of results.

SDK function policy ID: hubspot.marketing_events_identifiers_get_marketing_events_externalid. Catalog operation: marketing_events_identifiers_get_marketing_events_externalid. 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: ["crm.objects.marketing_events.read"]

Official provider source

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.