Create an embed session

post

https://api.oneschema.co/v1/embeds

Create an Importer embed session.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

embed_client_id

string

required

The Importer client Id from the OneSchema dashboard.

template_key

string

required

The key for the template that should be used in the import.

embed_user_jwt

string

required

The JWT to be used for authentication.

webhook_key

string

[Legacy] The key for the webhook that data should be sent to after import. This field should now be passed via the import_config parameter.

event_webhook_keys

array of strings

The keys of event webhooks which should listen to events in this embed session.

event_webhook_keys

dev_mode

boolean

Defaults to false

Whether the Embed is initialized in developer mode.

customization_key

string

An optional key for a customization made in OneSchema the importer should be styled with. If not provided, will use your default customization.

customization_overrides

object

The customization overrides to be used on this importer.

template_overrides

object

The template column overrides on the default template.

import_config

object

Configuration for how data will be imported out of OneSchema when the import is complete.

Responses

Language

Credentials

Header

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200

400400