Embedding an Osmos Uploader

This page outlines the implementation process for installing an Osmos Uploader from the Osmos platform onto your webpage.

Overview

Embed the Osmos Uploader within your app or website to offer a self-serve data import experience to your customers, partners, or vendors. Follow the steps below to embed your first Uploader.

Prerequisites

1. Destination Connector

2. Uploader HTML Snippet (Provided in Uploader Setup)

3. Access to your webpage HTML

Note: You can also embed your Osmos Uploader within a React app. See below for instructions.

Implementing an Osmos Uploader on Your Webpage

Step 1: Navigate to your web hosting provider's page configuration menu

Step 2: Copy the HTML Snippet from the Osmos platform

Step 3: Paste the snippet into your web page at the point where you'd like it to display on the page. Include both script tags and the button element together.

Step 4: Edit the snippet to set custom displayName and description values for schema. These will be shown to the user in place of the actual name. Note that you should not change the ordering of the fields from the order it appears in the snippet example.

Many additional configuration options are available. See Optional Configuration for more detail.

Embed Osmos Uploader in React App

To Embed Osmos Uploader in a React App, please use the GitHub example below:

examples/examples/osmos-uploader-with-reactjs-and-typescript at main · Osmos-io/examplesGitHub

Embed Osmos Uploader in NextJS App

To Embed Osmos Uploader in a NextJS App, please use the GitHub example below:

examples/examples/osmos-uploader-with-nextjs-and-typescript at main · Osmos-io/examplesGitHub