Try it outMCP ServerBook a demoCookbook

HTML Importer Beta

Welcome to the HTML Importer public Beta! We're excited to hear your feedback on this service, and develop it into a tool that'll bring value to your workflows, team, and SDK implementation.

Beta Feature Notice

This feature is currently in beta and may change before its official release. We appreciate your feedback and understanding as we continue to improve the HTML Importer experience.

Join the Beta This feature is currently in beta and is only accessible once we've enabled it on your account. If you're interested in testing the endpoint, and sending us feedback about your experience, feel free to send us a quick note.

We look forward to hearing your thoughts!

Happy testing,

Beefree SDK Team

Introduction

Currently, migrating your existing templates into Beefree SDK can be tedious and time-consuming. With the new HTML Importer endpoint, you can transform your existing HTML templates programmatically to Beefree's native JSON format, automating what used to be a majority manual process. With this endpoint, you can count on the majority of the HTML template conversion to be completed in the API call's response. You may still need to perform a few slight edits to the Beefree native JSON after the conversion, but the manual processing is significantly less than before.

How to use the endpoint

The following diagram provides a high-level visualization of how to perform API calls using the HTML Importer endpoint.

Tip: Keep in mind the content types for both the request and the response bodies of the API call. The Prerequisites section lists important requirements for the HTML you use in the POST request body when making the API call.

HTML Importer Endpoint Diagram

Prerequisites

Prior to performing an API call to convert your HTML to Beefree native JSON format, ensure it meets the following requirements:

  • DOCTYPE declaration

  • Include html and body elements

  • To prevent character encoding issues during conversion, include the <meta charset="UTF-8"> tag in the head section of your HTML before converting it.

Steps to perform the API call

Important: Prior to performing the steps in this section, ensure you request access to the HTML Importer Beta. If you did not request access yet, you can easily request it by sending us an email.

Take the following steps to perform the conversion:

  1. Ensure your API method is set to POST

  2. Enter the endpoint URL: https://api.getbee.io/v1/conversion/html-to-json

    1. Note: You can do this by setting the {collection} as equal to conversion in the url https://api.getbee.io/v1/{collection}/html-to-json

  3. Authenticate by entering your API key as a Bearer Token in the Auth Type field

  4. Ensure your request body's Content-Type is set to text/html

  5. Paste the HTML you'd like to convert into the request body field

  6. Click Send

Within a few seconds, you should receive a response containing the Beefree format JSON.

Test the endpoint here

You can test the endpoint in the following interactive environment. Ensure you follow the steps outlined in the Steps to perform the API call section to successfully execute the API call after clicking the Test it button. You can copy and paste the HTML in the Sample HTML Template to Convert expandable section below, or use your own HTML as a request body for experimenting with the Test it feature.

Required: Ensure you manually type in text/html in the Content-Type field prior to making the API call.

Sample HTML Template to Convert

You can use the following template if you'd like to test a conversion now:

HTML Importer

post

The HTML Importer API is an API built to easily convert HTML email templates into Beefree's JSON format.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
collectionstringRequired

The collection ID or name

Body
stringOptional
Responses
post
/v1/{collection}/html-to-json

Note: You will still need to authenticate in the Test it environment before making an API call. Visit the Developer Console to obtain your API key and enter it in the bearerAuth field.

FAQs

Explore answers to the most frequently asked questions

We have gathered some useful questions to help you better understand the beta program and the API you're about to use.

What is the HTML Importer API?

The HTML Importer API is an API built to easily transform HTML email templates into Beefree's JSON format.

What are the benefits of the HTML Importer?

Currently, migrating your existing templates into Beefree can be tedious and time-consuming. With the new HTML Importer, you can transform your existing HTML templates programmatically to Beefree's native JSON format, automating what used to be a manual process.

How does it work?

The HTML Importer leverages a series of algorithms to map and classify all the content elements available in the email, label them, and then translate them into the Beefree's JSON format.

Can I convert any HTML template?

There are a few limitations you should be aware of:

  • The conversion engine is designed to convert email HTML. It's not optimized for converting landing pages or other HTMLs.

  • Our API doesn't convert dynamically created HTML documents that leverage JavaScript to render content. We currently support static HTML and CSS content only.

  • We can't convert emails with images and resources that are only available on private networks. For us to convert your content, all email resources must be publicly available on the internet.

Do you store any of the templates I convert?

For the duration of this beta phase, we will store the uploaded HTML templates and the JSON we generate from it to troubleshoot and fix bugs so that our engineers can perform additional tests on existing files. This means we will have access to templates for the whole duration of the beta test, but they will be deleted 60 days after the end of this beta test.

During the beta test, we won't store any user information. If you have any concerns about data and users' information, feel free to contact us directly at [email protected] at any time.

What is the applicable use policy?

You can use this tool following the provisions of Beefree Terms of Service. In particular, you should use the tool in a way that ensures you will not violate the rights of third parties.

I have questions, feedback, or a bug to report. Who should I contact?

The HTML Importer is a beta test. Therefore, some hiccups may happen along the way—and we'd love for you to tell us if you experience any so we can improve the tool going forward.

If you want to contact us to report a bug or provide feedback, email us at [email protected].

What expectations do you have for me as a beta tester?

This program is designed to help us gather feedback and improve our product—and the more feedback we receive from customers like you, the easier it is for us to create a solution that truly meets your needs. That's why we'd love it if you would:

  • Share any feedback or questions you might have while using the API. You can do that by emailing [email protected].

  • Respond to our questionnaire, which we'll send to all beta users to gather feedback.

  • Be open to jumping on a call with our Product team to talk about your experience and needs.

Is this importer free of charge?

Access to the HTML Importer will be free during the beta. However, please note that we may charge for the converter in the future.

Can I use the API access provided in the beta program for production?

No, the API access provided in the beta program is strictly for testing and development purposes. It is not intended for production use, as the beta version may be subject to changes, downtime, or limitations that could impact reliability. We recommend using the stable, production-ready API for any live applications whenever it becomes available.

Complete the survey

Complete the survey below to share your thoughts on the HTML Importer API. We're excited to hear what you think, and to make this service widely available soon.

PreviousScheduled maintenances

Last updated

Was this helpful?