Conversations webhooks documentation update
Updated the Conversations webhooks documentation with new fields and corrections.
Message object — new fields:
rawUnsafeHtml— Raw unsanitized HTML of the messagesubject— Email subject line (present for email-source conversations)isSentViaJsApi—truefor messages sent via the JS APIsourceMessageId— Original message ID from the source platformfrom,to,replyTo,cc,bcc— Email conversation fieldsisForward—trueif the message is a forwarded message
Attachment object — new fields:
mimeType— MIME type of the fileisInline— Whether the attachment is inline (e.g. embedded images in emails)inlineId— Content-ID for inline attachments
Visitor object — new field:
isBanned— Whether the visitor is banned (inconversationTranscriptonly)
Corrections:
imageInfo.previewUrlrenamed toimageInfo.previewLinkin the conversation transcript payload- Image preview URL quality parameter updated from
lightertobetter
Node.js SDK beta release
We’ve released a beta version of the Node.js SDK (v4.0.1) with significant improvements including a promise-based API, enhanced TypeScript types, standardized error handling, and improved retry logic. You can learn more on the dedicated guide here: https://developers.brevo.com/docs/api-clients/node-js
The pre-release is now available on npm. Install it using:
Resources:
Dedicated rate limits for orders and products endpoints
Added dedicated rate limits for the following endpoints:
POST /v3/orders/statusPOST /v3/products
These endpoints now have specific rate limits that differ from the default limits applied to other endpoints. See the rate limits documentation for detailed limits by account tier.
Connect to Cursor guide
Added a new guide explaining how to connect the Brevo API documentation to Cursor via MCP (Model Context Protocol) server. This integration enables Cursor to access Brevo’s API documentation directly within your development environment.
Guide: Connect to Cursor
Automated Back-in-Stock Alerts
- Real-time inventory monitoring with new stock product parameter
- Captures customer intent via Subscription API or plugin
- Sends personalized email notifications with pre-built workflow
Check it out here: https://developers.brevo.com/reference/createproductalert
Custom objects now supported in events
- Event creation now supports custom objects.
- Enables hybrid contact/object event scenarios (e.g. trigger an automation when a quote is created).
- Improves autonomy in setting up custom object workflows.
Check it out here: https://developers.brevo.com/reference/createevent
Generate Rendered Preview of a Transactional Template
This new endpoint allows developers to generate a rendered HTML preview of a transactional email template using dynamic parameters or a contacts attributes.
Use Cases:
- Preview how a transactional template will render with real or test data.
- Validate personalization variables before sending emails.
- Automate template rendering in backend systems.
Route: Generate the rendered preview of transactional template
Deprecated Endpoint: POST /v3/transactionalSMS/sms
We’ve deprecated the former transactional SMS endpoint in favor of a more stable and simplified version.
While the deprecated endpoint will remain operational for an undetermined period, we recommend migrating to the new version.
Deprecated endpoint
POST [https://api.brevo.com/v3/transactionalSMS/sms](https://api.brevo.com/v3/transactionalSMS/sms)
Deprecated response payload
New endpoint
POST [https://api.brevo.com/v3/transactionalSMS/send](https://api.brevo.com/v3/transactionalSMS/send)
Current response payload
API Rate Limit Changes for GET /smtp/emails
We have introduced a new rate limit for GET /smtp/emails endpoint to improve system stability
New rate limits based on your account type:
Self-Service: 2 requests/second → 7,200 requests/hour
**Enterprise: ** 3 requests/second → 10,800 requests/hour
More information on our rate limit guide
Proxy open event supported for Marketing webhooks
Event proxy_open is now supported for Marketing Email webhooks.
Route: Create a webhook
New attribute type in Contacts attributes
A new User attribute type has been added for Contacts. Now, you can create custom attributes with dropdown values populated by your account’s invited users.
There are some points to consider for the new attribute type:
- User attribute can be created from the Contact settings page and Contacts endpoints
- User attributes can be imported by passing the valid email id or User ID of the user
- Exporting the User attributes results in exporting the email id of the users in the csv
- You can create segments using this new attribute type
- At present, you can only create maximum 20 User attributes for an account