HubSpot: Create Event

HubSpot mediaBridge.attentionSpan: arguments, response, policy and SDK examples.

Operation hubspot.media_bridge_attention_span

Provider route: POST /media-bridge/2026-09/events/attention-span. 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["mediaBridge"]["attentionSpan"]>[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.mediaBridge.attentionSpan(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.media_bridge.attention_span(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 Create Event — request body — body

Referenced models: Create Event — 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 Event — response body

Referenced models: Create Event — response body

Schemas

Create Event — request body — body

Field	Type	Presence	Description and constraints
`$`	object	Root
`_hsenc`	string	Optional	An encoded string used for HubSpot-specific encoding purposes.
`contactId`	integer	Optional	The unique identifier for the contact associated with the event. Format: int64
`contactUtk`	string	Optional	The unique tracking key for the contact, used for tracking purposes.
`derivedValues`	Model	Optional	Expand Create Event — request body — body derived Values
`externalId`	string	Optional	An external identifier for the event, typically used to correlate with external systems.
`externalPlayContext`	string	Optional	Additional context about the play event, typically used for external integrations. One of: EMAIL, EXTERNAL_PAGE
`mediaBridgeId`	integer	Optional	The unique identifier for the media bridge instance. Format: int64
`mediaName`	string	Optional	The name of the media involved in the event.
`mediaType`	string	Required within parent	The type of media involved in the event. Valid values include 'VIDEO', 'AUDIO', 'DOCUMENT', 'OTHER', and 'IMAGE'. One of: AUDIO, DOCUMENT, IMAGE, OTHER, VIDEO
`mediaUrl`	string	Optional	The URL of the media involved in the event.
`occurredTimestamp`	integer	Required within parent	The timestamp when the event occurred, represented as a Unix timestamp in milliseconds. Format: int64
`pageId`	integer	Optional	The unique identifier for the page where the event occurred. Format: int64
`pageName`	string	Optional	The name of the page where the event occurred.
`pageUrl`	string	Optional	The URL of the page where the event occurred.
`rawDataMap`	object	Required within parent	A map of raw data key-value pairs providing additional context about the event. Additional keys: see wildcard field
`rawDataMap.*`	integer	Additional keys	Format: int32
`rawDataString`	string	Optional	A raw data string containing additional information about the event.
`sessionId`	string	Required within parent	The unique identifier for the session during which the event occurred.

Referenced models: Create Event — request body — body derived Values

Create Event — response body

Field	Type	Presence	Description and constraints
`$`	object	Root
`contactId`	JSON	Required within parent
`contactId (anyOf 1)`	integer	Alternative	A string representing the unique identifier for the contact associated with the event. Format: int64
`contactId (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`externalPlayContext`	string	Optional	A string providing additional context about the play event from an external source. Known values: EMAIL, EXTERNAL_PAGE
`mediaBridgeId`	JSON	Required within parent
`mediaBridgeId (anyOf 1)`	integer	Alternative	A string representing the unique identifier for the media bridge instance. Format: int64
`mediaBridgeId (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`mediaBridgeObjectCoordinates`	string	Required within parent	A string detailing the coordinates of the media bridge object.
`mediaBridgeObjectTypeId`	string	Required within parent	A string representing the type identifier for the media bridge object.
`mediaName`	string	Required within parent	A string representing the name of the media content.
`mediaType`	string	Required within parent	A string indicating the type of media involved in the event, such as 'VIDEO', 'AUDIO', etc. Known values: AUDIO, DOCUMENT, IMAGE, OTHER, VIDEO
`mediaUrl`	string	Optional	A string containing the URL of the media content.
`occurredTimestamp`	JSON	Required within parent
`occurredTimestamp (anyOf 1)`	integer	Alternative	A string representing the timestamp of when the event occurred, in ISO 8601 format. Format: int64
`occurredTimestamp (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`pageId`	JSON	Optional
`pageId (anyOf 1)`	integer	Alternative	A string representing the unique identifier for the page. Format: int64
`pageId (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`pageName`	string	Optional	A string representing the name of the page where the media was accessed.
`pageObjectCoordinates`	string	Optional	A string detailing the coordinates of the page object.
`pageUrl`	string	Optional	A string containing the URL of the page where the media was accessed.
`percentRange`	string	Required within parent	A string indicating the range of percentages that were played during the session.
`portalId`	JSON	Required within parent
`portalId (anyOf 1)`	integer	Alternative	An integer representing the unique identifier for the HubSpot portal. Format: int32
`portalId (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`providerId`	JSON	Required within parent
`providerId (anyOf 1)`	integer	Alternative	A string representing the unique identifier for the media provider. Format: int32
`providerId (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`rawData`	string	Optional	A string containing raw data associated with the event.
`sessionId`	string	Required within parent	A string representing the unique identifier for the session during which the media was played.
`totalPercentPlayed`	JSON	Required within parent
`totalPercentPlayed (anyOf 1)`	number	Alternative	A number indicating the total percentage of the media that was played.
`totalPercentPlayed (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`totalSecondsPlayed`	JSON	Optional
`totalSecondsPlayed (anyOf 1)`	integer	Alternative	A number representing the total seconds of media that were played. Format: int32
`totalSecondsPlayed (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Create Event — request body — body derived Values

Field	Type	Presence	Description and constraints
`$`	object	Root
`totalPercentPlayed`	number	Required within parent	The percentage of the media content that was played. This is a numerical value indicating how much of the total content was viewed, expressed as a percentage.
`totalSecondsPlayed`	integer	Required within parent	The total duration in seconds that the media content was played. This is a numerical value representing the cumulative playtime. Format: int32

Policy, approvals and errors

SDK function policy ID: hubspot.media_bridge_attention_span. Catalog operation: media_bridge_attention_span. 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: ["media_bridge.write"]

Official provider source

Report an issue with this page