Docs Home

Glossary

Changelog

Embeddables Docs

Welcome to Embeddables

Features

How-Tos

Tutorials

Reference

Dashboard

Embeddables.com

Support

Retrieve a specific version of an embeddable from the database based on the ID and version number

Get Embeddable Version

DateTime

The unique identifier for a Embeddable in the database

EmbeddableId

EmbeddableVersionNumber

ErrorBody

The JSON representation of the embeddable, stringified

JsonString

The unique identifier for a Project in the database

ProjectId

EmbeddableVersionWithJson

UnauthorizedErrorBody

EmbeddableDoesNotExistErrorBody

EmbeddableVersionDoesNotExistErrorBody

Welcome to the brand new home for the Embeddables documentation

Introduction

Get to know what's possible to build in Embeddables

10-min Tour of Embeddables

10-minute Tour of Embeddables

Go from zero to a published embeddable in a matter of minutes

Build Your First Embeddable in 10 mins

Adding text, inputs, images, and other elements

Content

Designing

Logic

How to start getting more out of the Embeddables platform

Next steps

How to make pixel-perfect design in Embeddables

Designer

How to get the most out of our Layers feature

Layers

How saving and versioning works in Embeddables

Saving and Versions

How to run best-in-class experiments in Embeddables

Split Testing

How our Stripe integration works, and how to use it

Stripe

How our PayPal integration works, and how to use it

PayPal

What the Webhooks feature is for, and how to use it

Webhooks

What the Airtable feature is for, and how to use it

Airtable

What the HubSpot feature is for, and how to use it

HubSpot

What the Sendgrid feature is for, and how to use it

Sendgrid

What the Google Sheets feature is for, and how to use it

Google Sheets

What the DataStream feature is for, and how to use it

DataStream

How to get the most out of custom code blocks in Embeddables

Writing Custom Code

What URL params are available to use when viewing embeddables

URL Params

How to get the most out of our in-built Debugger tool

Debugger

Updating the URL on page changes so that the browser back buttons control the embeddable

How To: Sync page changes with the browser URL

Data Pipelines? API requests? Something else?

How To: Decide how to send/receive data

URL params? Embed code? Window functions? Etc...

How To: Pass data in/out to be prefilled

How To: Pass data into/out of embeddables to be prefilled

Setting up pages, user data, analytics and more.

How To: Run custom code on first load

How To: Run custom code when the Embeddable loads

How to set up a webhook in Stripe so that, when a payment method is first added to a customer, it is automatically set as the default payment method.

How To: Automatically set default payment methods in Stripe

How to publish your embeddable to your website

How To: Embed in your site

How to publish your embeddable inside a React app

How To: Embed in a React app

How to publish your embeddable inside a React Native app

How To: Embed in a React Native app

Start building awesome embeddables in 10 minutes or less

10-min Quickstart

10-minute Quickstart

Why we write docs, our reader personas, and key use-cases.

Who are these docs for?

How we write docs

Key terms that we use here at Embeddables

Get programmatic access to your embeddables and your data

Embeddables API - Introduction

Get Embeddables

Retrieve an embeddable from the database based on the ID

Get Embeddable

Retrieve all versions of an embeddable from the database based on the ID

Get Embeddable Versions

Get Entries

Retrieve all pages viewed, with timestamps, for all entries in the database

Get Entries' Page Views

Retrieve all events for entry from the database based on the ID

Get Entry Events

Retrieve an entry from the database based on the ID

API Documentation

Embeddables

Entries

Events

Get Embeddable Version

Headers

Path Parameters

Response