Events API Collections

Number of APIs: 35

Custom events enable you to define and track events that are unique to your business, such as events on your site or in an app. You can configure events to store information within properties, which you can then use across HubSpot's tools.

To send custom event data to HubSpot, you first need to define the event. This is similar to custom CRM objects, where you first need to define the custom object before you can create individual records for that object. An event definition includes details such as its metadata, CRM object associations, and properties.

Below, learn more about creating and managing event definitions using the API. To learn how to create event definitions without using the API, check out HubSpot's Knowledge Base.

Fork the collections using Run in Qodex:

Run In Qodex

  1. Custom Behavioral Events API - Fetch Single Custom Behavioral Event Definition GET {{baseUrl}}/events/v3/event-definitions/:eventName

  2. Custom Behavioral Events API - Fetch Single Custom Behavioral Event Definition GET {{baseUrl}}/events/v3/event-definitions/:eventName

  3. Custom Behavioral Events API - Modify Single Custom Behavioral Event Definition PATCH {{baseUrl}}/events/v3/event-definitions/:eventName

  4. Custom Behavioral Events API - Modify Property for Custom Behavioral Event Definition PATCH {{baseUrl}}/events/v3/event-definitions/:eventName/property/:propertyName

  5. Custom Event Definitions API-Event definition - Query custom event definitions GET {{baseUrl}}/events/v3/event-definitions?searchString=<string>&after=<string>&limit=<integer>&includeProperties=<boolean>&sortOrder=<string>

  6. Custom Event Definitions API-Event definition - Create custom event definition POST {{baseUrl}}/events/v3/event-definitions

  7. Custom Behavioral Events API - Create Property for Custom Behavioral Event Definition POST {{baseUrl}}/events/v3/event-definitions/:eventName/property

  8. Custom Event Definitions API-Event definition - delete-/events/v3/event-definitions/{event Name} DELETE {{baseUrl}}/events/v3/event-definitions/:eventName

  9. Custom Event Definitions API-Event definition - Create a new property for a custom event definition. POST {{baseUrl}}/events/v3/event-definitions/:eventName/property

  10. Custom Event Definitions API-Event definition - Update a custom event definition PATCH {{baseUrl}}/events/v3/event-definitions/:eventName