HubSpot: Send a batch of event occurrences

← Event completions operations · Get started

Operation hubspot.event_completions_batch_send_occurrences

Provider route: POST /events/2026-09/send/batch. 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["eventCompletions"]["batchSendOccurrences"]>[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.eventCompletions.batchSendOccurrences(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.event_completions.batch_send_occurrences(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
body	Model	Required within parent	Expand Send a batch of event occurrences — request body — body

Referenced models: Send a batch of event occurrences — 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
$	null	Root

Schemas

Send a batch of event occurrences — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
inputs	array	Required within parent	An array of BehavioralEventHttpCompletionRequest objects, each representing a single behavioral event to be completed. This property is required.
inputs[]	Model	Each item	Expand Send a custom event occurrence — request body — body

Referenced models: Send a custom event occurrence — request body — body

Send a custom event occurrence — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
email	string	Optional	The visitor's email address. Used for associating the event data with a CRM record.
eventName	string	Required within parent	The event's fully qualified name. This value (formatted as `pe{HubID}_{name}`) can be retrieved through the [event definitions API](https://developers.hubspot.com/docs/reference/api/analytics-and-events/custom-events/custom-event-definitions#get-%2Fevents%2Fv3%2Fevent-definitions) or in [HubSpot's UI](https://knowledge.hubspot.com/reports/create-custom-behavioral-events-with-the-code-wizard#find-internal-name).
objectId	string	Optional	The ID of the record for which the event occurred (e.g., contact ID or visitor ID).
occurredAt	string	Optional	The time when this event occurred. If this isn't set, the current time will be used. Format: date-time
properties	object	Required within parent	The event properties to update. Takes the format of key-value pairs (property internal name and property value). Learn more about [HubSpot's default event properties](https://developers.hubspot.com/docs/guides/api/analytics-and-events/custom-events/custom-event-definitions#hubspot-s-default-event-properties). Additional keys: see wildcard field
properties.*	string	Additional keys
utk	string	Optional	The visitor's usertoken. Used for associating the event data with a CRM record.
uuid	string	Optional	A unique identifier for the event occurrence. Must be unique within the event type. If not provided, HubSpot will generate a random UUID. When multiple events have the same ID within a year, the first will be accepted and all others will be rejected. Can be useful for matching data between HubSpot and other external systems.

Policy, approvals and errors

SDK function policy ID: hubspot.event_completions_batch_send_occurrences. Catalog operation: event_completions_batch_send_occurrences. 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: ["analytics.behavioral_events.send"]

No-content response statuses: [204]

Official provider source