Skip to content

Create custom events

Last updated: February 1, 2024

Available with any of the following subscriptions, except where noted:

Marketing Hub Enterprise
Sales Hub Enterprise
Service Hub Enterprise
Operations Hub Enterprise
CMS Hub Enterprise

Custom events allow you to define and track events that are unique to your business. Custom events can be tied to event properties, which you can then use across HubSpot's tools. 

There are three different ways to create custom events: 

  • Send via API: use the Custom event definition endpoint to create your event. From there, use your event ID with the send Custom event endpoint to send event completions to HubSpot.
  • Capture data from your website without the API:
    • Code Javascript: using Custom Javascript, you can insert custom code into your HubSpot tracking script by using the code editor.
    • Use event visualizer: track page views or clicked elements by selecting them on your website. Learn more about creating Custom events with the Event visualizer.
  • Import spreadsheet: upload a spreadsheet of event data to capture offline activity, backfill data, or manually integrate any tool with HubSpot.

 

Please note: the custom events tool replaces the previous events legacy tool. Any events created in the legacy tool will continue to work, and you can still manage and analyze those events in the legacy tool

The event creation process involves two parts:

  • Defining the event in HubSpot, including any custom event properties.
  • Creating a Javascript Code Snippet or Defining the API call that will trigger the event. 

Create event via API

If you’re sending data to HubSpot via API, you’ll need to use the Custom event definition endpoint to create your event. Then, you'll need to define the API call to trigger the event. Learn how to define your API call in HubSpot's developer documentation.

You'll need a few pieces of information for your API call, which you can get from inside HubSpot:

  • Event name: the internal name for the event. 
  • Property names: the internal names for the properties you'll be sending data to.

To finish creating your event to send data via API:

  • Select Send data to HubSpot and copy the Tracking ID.
  • Click Create.

To find the internal event name for an existing event and property names:

  • In your HubSpot account, navigate to Reporting > Data Management > Custom events.
  • Click Custom events.
  • Click the name of the event. You'll then be taken to the event details page.
  • At the top, locate the event name under Internal name.

    internal-name-custom-event
  • To find the internal names for the properties you'll be updating, click the name of a property.
  • In the right panel, click the code icon, then view the name under Internal name.
Please note:
When sending data to your event, the below limits apply:
  • The property names are limited to 50 characters. 
  • URL and referrer properties can receive up to 1024 characters, while all other properties can receive up to 256 characters.
  • Each event completion can contain data for up to 50 properties.
  • Property internal names must start with a letter and contain only lowercase letters a-z, numbers 0-9, and underscores. Properties with the same internal name after lowercasing are considered duplicates, and only one of the properties will be used on completion.
If these limits are exceeded when making an HTTP API request, the request will fail. If these limits are exceeded when making a JS API request, HubSpot will truncate any property name values to the allowed length and/or update only 50 properties per event completion.

Create events with a Javascript code snippet

  • In your HubSpot account, navigate to Reporting > Data Management > Custom events.
  • In the top right, click Create an event.
  • Select Code Javascript.
code-javascript
  • Click Next.
  • Enter an Event name and optionally provide your event description.
  • Select an Associated object. This allows you to associate your event completions with different objects in HubSpot, including Contacts, Companies, Deals, and Tickets
custom-event-details

  • Click Next.

Add properties

When an event is created, default event properties will be available. You can also create your own custom properties. Event properties are stored separately from other CRM properties, and are unique to the event (i.e. you can't edit these properties from your account settings). 

To create properties for an event:

  • Select the property type by clicking the Field type for your property. Options include: 
    • Custom string property: create a property that is a plain text string. 
    • Custom number property: create a property that is a number value.
    • Custom timestamp property: create a property that’s a date value. You must send your data in the form of epoch milliseconds or ISO8601. 
    • Custom enumeration property: create a property with a set of predefined values.

      create-property-custom-behavioral-event
    • When you have selected your property, configure the property in the right panel:

    • Enter a name for the property and enter a Description for the property.
    • For Enumeration properties, click Next and enter your property Labels and Values. You must set your values and labels before sending data to them. If this step is not completed before sending data that’s not in the list, the data will not be available to use. To send multiple values, separate them with a semicolon.
    • Click Done.
    • Once your property is created, it will appear in the table under HubSpot’s default event properties. You can edit or delete your property by selecting the Actions dropdown and selecting Edit or Delete
  • Click Next.
  • After setting up the event and its properties, you can add this event to your website’s tracking code by selecting Javascript code snippet.

Creating events with a Javascript code snippet allows you to add Javascript to your HubSpot tracking code automatically. This can be used for capturing more complex event data which the tracking code does not capture by default. 

  • Select Javascript code snippet. Use the snippet in the right panel to track the event in HubSpot. Any custom properties created will be predefined within the code snippet. 
  • Modify the snippet as needed by entering text within the right panel. Any code you add will automatically be included as part of your HubSpot tracking code.
  • When you’re finished, click Create to finish your event and automatically start tracking. 
    example-code-snippet-custom-event

Import event data

Upload your attendance data from in person events, timestamped data coming from apps you don't integrate with HubSpot, one off lead or campaign data from a vendor, or any other event data in spreadsheet form. Events allow you to capture behavior and then use the behavior across HubSpot. 

  • In your HubSpot account, navigate to Reporting > Data Management > Custom events.
  • In the top right, click Create an event.
  • Select Import spreadsheet.
import-spreadsheet
  • Click Next.
  • Enter an Event name and optionally provide your event description.
  • Select an Associated object. This allows you to associate your event completions with different objects in HubSpot, including Contacts, Companies, Deals, and Tickets

custom-event-details

  • Drag and drop a file in the Select a file section or click Choose a file to upload a file from your computer.
Please note: when importing event data, the below limits apply:
  • Your file must be a csv, .xlsx, or .xls file type 
  • Limited to 1 million rows.
  • For now, events created via import can only be associated with Contacts. 
  • Events will create and update contact records. The import will create new records and activities, as well as identify and update existing records. To create new records or activities, your file must contain the required properties for that contact. To update existing records, your file must contain a unique identifier.
  • Event import should be used for events which have already occurred, events with future dates are not supported.

 

  • Click the dropdown menu to select the language of your column headers.
upload-spreadsheet-events
  • Click Next.
  • On the Map columns in your file to HubSpot properties screen, HubSpot will map the columns in your file to the contact and event properties based on the header, the header language, and the property name.
  • The Mapping Guide displays the properties required to create and/or update the contacts and events. If your file is missing any of the properties needed to complete the goal of your import, you should fix your import file and restart the import to avoid errors.
  • Columns in your spreadsheet can be mapped to either contact properties or event properties. Click the Import as dropdown menu to select how to import the data in the file. Then, select the HubSpot property to map it to. You can map it to an existing property or create a new property.
create-new-property
  • Click Next.
  • Confirm the name of your import file.
  • Click the checkbox to agree that contacts expect to hear from you and that your import file does not include a purchased list. Learn more about HubSpot's acceptable use policy.
  • Click the dropdown menu to select the date format of the Occurred at property.
  • Click Finish import.

Use custom event data

Custom event data can be viewed and used across HubSpot's tools. Below, learn where to view event completions and the ways that you can incorporate that data into other tools.

You can open your selected events directly in select HubSpot tools with the actions dropdown in your event list, the single event view, or the top right corner of charts in the analyze tab.

Report on custom events

Custom event completions can be analyzed from the custom events tool, and event data will also be available in the custom report builder and attribution reports.

Learn more about analyzing your custom events.

View event completions on the contact timeline

Event completions will appear on the contact record timeline, along with any properties that were populated.

To view event details on the contact timeline:

  • Navigate to a contact record that has completed a custom event.
  • To filter a contact timeline by completed events, click Filter activity, then select Custom event.
  • In the contact timeline, click to expand the event to display the event details.

Use custom events in workflows

In a workflow, you can delay based on custom event completions using a Delay until event happens action or an event enrollment trigger.

  • In your HubSpot account, navigate to Automation > Workflows.
  • Click the name of a workflow. Or, learn how to create a new workflow.
  • To add a trigger:
    • In the workflow editor, click Set up triggers.
    • In the left panel, select When an event occurs. Set up the trigger, then click Apply filter.
    • To further refine your trigger, click Add refinement filters. You can select additional properties to refine the objects that you would like to enroll in the workflow.
    • By default, records will only enroll in a workflow the first time they meet the enrollment triggers. To enable re-enrollment, under the Should [object] be re-enrolled in this workflow? section, select Yes, re-enroll every time the trigger occurs.
  • To add a delay:
    • In the workflow editor, click the + plus icon to add a workflow action.
    • In the right panel, select Delay until event happens.
    • Configure the delay:
      • Click the Event dropdown menu, then select a custom event.
      • Then, select the event property that you want to delay on.
      • Select the filter for the event property.
      • Click Apply filter.
      • Select the maximum wait time, or select the Delay as long as possible checkbox.
  • Click Save.

Please note: all event enrollment triggers will be separated using the OR operator. This means that only one of the event enrollment triggers must occur for the record to enroll in the workflow.

The workflow will then delay enrolled records until they meet the specified custom event criteria or will be triggered when the event occurs.

Was this article helpful?
This form is used for documentation feedback only. Learn how to get help with HubSpot.