Custom Behavioral Events API

Name: Custom Behavioral Events API API
Brand: Custom Behavioral Events API
Availability: InStock

★ Only Publicly Available OpenAPI DocumentAnalyticsProduct AnalyticsapiKey, oauth21 EndpointsREST

For Agents

Send a custom behavioral event into HubSpot's analytics so it becomes available for segmentation, workflows, and reporting on the matching contact.

Connect the Custom Behavioral Events API to your agent

Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Custom Behavioral Events API, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.

Install Jentic One Beta (Self-Hosted)

Jentic One Host machine

# On the machine that will host your Jentic One instance:
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh

Agent machine

# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh
jentic register       # connects your agent to your Jentic One instance

Jentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.

Capabilities

What an agent can do with Custom Behavioral Events API API.

Send a custom behavioral event for a contact via POST /events/v3/send

Attach typed event properties (string, number, datetime, enum) defined up front in HubSpot

Identify the contact by email, utk, or objectId on the same send call

Trigger downstream HubSpot workflows that listen for the named event

GET STARTED

Start building with Custom Behavioral Events API API

Explore with Jentic

View OpenAPI Document

Jentic publishes the only available OpenAPI document for Custom Behavioral Events API, keeping it validated and agent-ready.

Jentic publishes the only available OpenAPI specification for Custom Behavioral Events API, keeping it validated and agent-ready. HubSpot's Custom Behavioral Events API lets product and marketing teams send custom events into HubSpot's behavioral analytics so those events can drive segmentation, automation, and reporting alongside form submissions and page views. The single endpoint accepts a defined event name and per-event property values keyed to a contact. It is the integration point for piping product usage signals — feature_used, plan_upgraded, trial_started — into HubSpot's customer record.

Use Cases

Patterns agents use Custom Behavioral Events API API for, with concrete tasks.

★ Pipe Product Usage Events into HubSpot

Send product events such as feature_used, trial_started, or plan_upgraded into HubSpot so marketing can build segments and workflows on real product behaviour, not just web activity. POST a single event to /events/v3/send with the event name, the contact identifier, and the event properties.

POST to /events/v3/send with eventName pe123_feature_used, email user@example.com, and properties {feature: dashboard_export}.

Drive Lifecycle Marketing on Real Behaviour

Trigger HubSpot lifecycle workflows when users hit specific in-product milestones. Sending a trial_completed or activation_reached event fires any workflow that listens for that event name, removing the need to poll HubSpot lists.

POST to /events/v3/send with eventName pe123_trial_completed and the contact email so the corresponding nurture workflow fires.

Build Segments on In-App Behaviour

After events flow into HubSpot, marketing can build active lists that filter on event recency or property values — for example, contacts who fired plan_downgraded in the last 14 days. The send endpoint is the only programmatic way to land those events as first-class HubSpot data.

POST 100 plan_downgraded events for the affected cohort to /events/v3/send, then build a HubSpot active list filtering on that event in the last 14 days.

AI Agent Behavioural Telemetry via Jentic

An AI agent that detects an in-product action — for example, abandoning checkout — uses Jentic to find and call the Custom Behavioral Events endpoint and record the event against the matching HubSpot contact, with the API key held in the Jentic vault.

Search Jentic for send a hubspot behavioral event, load /events/v3/send, and execute with eventName, email, and properties.

Key Endpoints

1 endpoints — jentic publishes the only available openapi specification for custom behavioral events api, keeping it validated and agent-ready.

METHOD

PATH

DESCRIPTION

POST

/events/v3/send

Send a custom behavioral event for a contact

POST

/events/v3/send

Send a custom behavioral event for a contact

Why though Jentic?

Three things that make agents converge on Jentic-routed access.

Credential isolation

HubSpot hapikeys, OAuth tokens, and private-app tokens are stored encrypted in the Jentic vault and injected per-call. Agents only see scoped execution access — never the raw secret.

Intent-based discovery

Agents search Jentic with intents like send a behavioral event to hubspot and Jentic returns /events/v3/send with its input schema (eventName, email, properties).

Time to first call

Direct integration: 1-2 hours for auth setup and event definition wiring. Through Jentic: under 15 minutes once the event definition exists in HubSpot.

Related APIs

Alternatives and complements available in the Jentic catalogue.

Alternative

HubSpot Events API

Read built-in HubSpot CRM events rather than sending custom behavioral events

Choose the Events API when the agent needs to consume event history rather than write new behavioral events in.

Complementary

HubSpot CRM API

Look up or upsert the contact record that the behavioral event is keyed to

Pair with the CRM API when the agent needs to ensure a contact exists before sending events keyed by email or utk.

Alternative

Segment

Generic customer data platform that can fan-out events to HubSpot among many destinations

Choose Segment when the same event needs to land in many tools, not just HubSpot.

FAQs

Specific to using Custom Behavioral Events API API through Jentic.

Why is there no official OpenAPI spec for Custom Behavioral Events API?

HubSpot does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call Custom Behavioral Events API via structured tooling. It is validated against the live API and kept up to date. Get started at https://app.jentic.com/sign-up.

What authentication does the Custom Behavioral Events API use?

The API supports HubSpot hapikey (query parameter), OAuth 2.0 authorization code with the analytics.behavioral_events.send scope, and private-app legacy tokens (private-app-legacy header). Through Jentic, whichever credential you have configured is held encrypted in the vault and injected at call time.

Can I send a custom event keyed by email instead of HubSpot contact ID?

Yes. The /events/v3/send body accepts email, utk, or objectId to identify the contact. Email is the simplest when integrating from a product backend that already stores the customer's email.

What are the rate limits for the Custom Behavioral Events API?

HubSpot enforces standard hapikey and OAuth rate limits — generally 100 requests per 10 seconds per key on Marketing Hub Enterprise. Behavioral event volume can be high, so check the developer dashboard before sending bulk batches.

How do I send a behavioral event through Jentic?

Search Jentic for send a hubspot behavioral event, load /events/v3/send, and execute with eventName (the internal event name like pe123_feature_used), an email or utk to identify the contact, and the properties payload defined in HubSpot.

Do custom events automatically appear in HubSpot reports?

Yes, once the event definition exists in HubSpot. The API send call lands an instance of the event against the contact; HubSpot's analytics, lists, and workflows then treat that event the same as built-in ones.