January 2025 Rollup
Our January update includes enhanced App Usage Insights with detailed analytics on how users interact with their apps in HubSpot, a new two-year certification cycle for all certified apps to ensure ongoing compliance with ecosystem standards, enriched CRM Object API error messages for easier debugging with detailed property validation information for easier debugging and a dedicated App Usage tab for improved API monitoring and usage tracking. Additionally, we’ve launched a public beta to hide classic CRM cards for new installs and introduced new beta endpoints for the Invoice API.
Please read more below.
Developer Updates for January 2025
Enhanced App Usage Insights
This month, we’re excited about the enhanced App Usage Insights feature, which introduces improved reporting capabilities for developers by providing detailed, aggregate data on how app users interact with your app in HubSpot. This data goes beyond the previous 30-day logs limit and includes insights into specific user activities, such as associations created, searches executed, and contacts updated.
What's Changing?
Developers can now access aggregated app activity data based on successful API operations (e.g., searches, associations, and updates) performed via the app. These insights are now available directly on the Marketplace Analytics page for your app listing, with the ability to filter by date range and operation type.
This change enables developers to identify which features drive value or require further optimization based on user activity. You can do so by navigating to Marketplace > App Listings, selecting your app, and reviewing the activity data by date range and operation type on the respective Marketplace Analytics page.
Introducing Two-Year App Certification Cycle
This new two-year certification cycle for all certified apps is designed to ensure ongoing compliance with our standards and ecosystem requirements. Apps must renew certification every two years to maintain their certified status.
What You Need to Know
- Renewal Notifications: You’ll receive a notification 3 months before your app’s certification expires, giving you time to update and re-certify.
- New Developer Tools: Later this year, the developer portal will feature tools to streamline renewals including step-by-step guidance, status tracking and seamless submissions.
Next Steps
- Mark your app’s expiration date and prepare updates early.
- Use the 3-month notification as a reminder to start the renewal process.
- Stay tuned for developer portal updates to simplify certification management.
*Note: Lapsed certification may affect your app’s visibility or functionality.
Enriched Error Messages will now appear in CRM Object APIs
We are introducing a new enriched error message for the CRM Object APIs. The error message will now include detailed property validation error information within a new “errors” field.
Feature Updates
The standard response bodies will now include a new structured field that provides detailed information about property validation failures and offers more descriptive error messages with each sub-error containing a message, code and context. This change aims to enable developers to identify and correct property-specific errors faster.
Before, the response body was structured like this:
Now, the response body will be structured like this:
You can leverage these error fields in your response body of requests as needed.
You will also be able to continue using the existing “message” field to parse error messages. Message field contents and formatting will remain unchanged.
New App Usage Tab for API Monitoring
We’re introducing a new "App Usage" tab within your developer account to provide greater visibility into how your app is being used. This feature enables app partners to track and understand API usage patterns, offering insights into customer engagement with your app’s functionality.
You can filter usage data by date range, with a default view set to the last month and drill down into specific periods to analyze trends and customer behavior. The detailed metrics include the date of API calls, the specific endpoints requested and the number of successful calls without errors. You can also export this data for further analysis and reporting outside the platform.
Public Betas
App Cards: Hide Classic CRM Cards for New Installs
In addition to using the feature flags API to roll out app cards to your install base, you can also use it to facilitate the removal of classic CRM cards by setting the hs-hide-crm-cards
flag.
For example with existing installs, you may want to continue showing the old cards to remind users to upgrade to your new cards then hide them from new installs and accounts that have upgraded.
View full documentation with instructions available here.
Invoices API Update
Previously, the Invoices API was limited to read-only access, allowing users only to retrieve information about their invoices without the capability to create or manage them. On January 30th, we are introducing the enhanced functionality of the Invoices API by introducing new beta endpoints that enable users to create invoices for customer payments.
This latest public beta will facilitate a smoother invoicing process by automating invoice creation, integrating with other systems for creating invoices in HubSpot and reducing errors associated with manual data entry for invoices.
New Enhancements
Invoice Creation and Management Capabilities:
- Adding the ability to create, update, delete and associate invoices.
- Introducing the concept of invoice statuses (Draft, Open, Paid, and Voided).
New API Endpoints:
Create new invoices |
POST |
Update existing invoices |
PATCH |
Delete invoices |
DELETE |
Create a batch of invoices |
POST |
Associate object types with an invoice |
PUT |
Payment Configuration:
- Adding support for configuring payments using HubSpot Payments or Stripe.
- Properties for payment settings such as
hs_allowed_payment_methods
andhs_invoice_payment_collection_method
can now be configured via API.- Note: The Invoices API cannot update a payment status on invoices. The Payments API is required for this and is expected to be available later this year.
- Note: The Invoices API cannot update a payment status on invoices. The Payments API is required for this and is expected to be available later this year.
Associations Enhancements:
- Adding
PUT
endpoint for associating invoices with CRM records (e.g., contacts, companies, line items). - New association types and IDs for managing links between invoices and CRM objects. This also includes associating line item taxes to an invoice and using the Tax Rates API to fetch a tax rate and set the new property
hs_tax_rate_group_id
.
New Properties:
- Detailed descriptions for new properties, including tax ID, currency, payment collection settings, and invoice billable, can be referred to in the API documentation. You can also request a list of all available properties by making a
GET
request to/crm/v3/objects/invoices
. - Custom fields and shipping and billing address fields were added for greater invoice customization.
Non-Billable Invoices:
- New capability to create “non-billable” invoices. Invoices with data that are not functional or rendered. This type of invoice is indicated when using a new boolean property
hs_invoice_billable
.
Batch Operations:
- New
POST
endpoint to create invoices in batches.
Enhanced Error Handling and Autoset Features:
- Properties like
hs_invoice_date
andhs_due_date
now auto set if not provided. - Refer to the API documentation on required fields for specific statuses (e.g., contact and line items for Open invoices).
The public beta of the Invoices API now provides complete lifecycle management for invoices, allowing for their creation, modification and deletion. Developers using HubSpot Payments or Stripe must update payment settings accordingly and ensure that the required properties are set for specific invoice statuses to prevent problems.
Refer to the API documentation for further details and code examples.
Questions or comments? Discuss these updates on our developer community forums.