HubSpot Events API
Tools that enable LLMs to interact directly with the Hubspot Events API
2.0.0
Arcade's HubspotEventsApi toolkit enables LLMs to interact seamlessly with the Hubspot Events API, streamlining event management for developers. It provides the necessary tools for creating, updating, retrieving, and deleting custom event definitions.
Capabilities
- Manage custom event definitions in Hubspot efficiently.
- Access and update event properties with ease.
- Retrieve information on existing events and their types.
- Facilitate the cleanup of unnecessary event definitions.
OAuth
- Provider: Unknown
- Scopes: behavioral_events.event_definitions.read_write, oauth
Secrets
- No secrets are required for authentication.
Available tools(6)
| Tool name | Description | Secrets | |
|---|---|---|---|
Delete a custom event definition by name.
Use this tool to delete a specified custom event definition in HubSpot by providing the event name. It is useful for managing and organizing event definitions that are no longer needed. | |||
Delete a property from a custom event definition.
Use this tool to remove an existing property from a specific custom event definition in Hubspot. | |||
Fetch details of a custom event definition by name.
Use this tool to retrieve the definition and details of a specific custom event by providing its name. | |||
Retrieve a list of visible event type names.
This tool retrieves a list of event type names that are visible to the user, which can be used to query specific event instances. | |||
Retrieve existing custom event definitions from Hubspot.
Use this tool to obtain the current list of custom event definitions stored in Hubspot. It helps in understanding or displaying existing events configured within your system. | |||
Update a specific custom event definition by name.
Use this tool to update the definition of a specific custom event in Hubspot by specifying the event name. |
Selected tools
No tools selected.
Click "Show all tools" to add tools.
Requirements
Select tools to see requirements
HubspotEventsApi.DeleteCustomEventDefinition
Delete a custom event definition by name. Use this tool to delete a specified custom event definition in HubSpot by providing the event name. It is useful for managing and organizing event definitions that are no longer needed.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
event_name | string | Required | The name of the custom event definition to delete. |
Requirements
Output
json— Response from the API endpoint 'delete-/events/v3/event-definitions/{eventName}'.HubspotEventsApi.DeleteCustomEventProperty
Delete a property from a custom event definition. Use this tool to remove an existing property from a specific custom event definition in Hubspot.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
custom_event_internal_name | string | Required | The internal name of the custom event from which the property will be deleted. |
property_internal_name | string | Required | The internal name of the property to delete from the custom event. |
Requirements
Output
json— Response from the API endpoint 'delete-/events/v3/event-definitions/{eventName}/property/{propertyName}'.HubspotEventsApi.FetchEventDefinitionByName
Fetch details of a custom event definition by name. Use this tool to retrieve the definition and details of a specific custom event by providing its name.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
event_name | string | Required | The internal name of the custom event to fetch its definition. |
Requirements
Output
json— Response from the API endpoint 'get-/events/v3/event-definitions/{eventName}'.HubspotEventsApi.ListEventTypes
Retrieve a list of visible event type names. This tool retrieves a list of event type names that are visible to the user, which can be used to query specific event instances.
Parameters
No parameters required.
Requirements
Output
json— Response from the API endpoint 'get-/events/v3/events/event-types_getTypes'.HubspotEventsApi.RetrieveCustomEventDefinitions
Retrieve existing custom event definitions from Hubspot. Use this tool to obtain the current list of custom event definitions stored in Hubspot. It helps in understanding or displaying existing events configured within your system.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
event_name_search_string | string | Optional | String of characters to search for in event names. This is a simple 'contains' search without fuzzy matching. |
include_event_properties | boolean | Optional | Include event properties in the response. Set to true to include all properties. |
paging_cursor_token | string | Optional | The token indicating the position after the last successfully read resource for continued paged results. |
results_per_page_limit | integer | Optional | The maximum number of event definitions to retrieve per page. |
sort_order | string | Optional | Specify the order to sort results. Use 'ASC' for ascending or 'DESC' for descending. |
Requirements
Output
json— Response from the API endpoint 'get-/events/v3/event-definitions'.HubspotEventsApi.UpdateCustomEventDefinition
Update a specific custom event definition by name. Use this tool to update the definition of a specific custom event in Hubspot by specifying the event name.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
internal_event_name | string | Required | The internal name of the custom event to be updated in Hubspot. |
event_description | string | Optional | Provide a description for the custom event to be displayed as help text in HubSpot. |
event_label | string | Optional | The human-readable label for the event, used in the HubSpot UI. |
Requirements
Output
json— Response from the API endpoint 'patch-/events/v3/event-definitions/{eventName}'.