Sign in

v1

latestOpenAPI 3.1.0proprietary2026-07-24156175241.3 KB
Headless Importer

Create an embed session

Create an Importer embed session.

post/v1/embeds

Request body

embed_client_idstring required

The Importer client Id from the OneSchema dashboard.

template_keystring required

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

embed_user_jwtstring required

The JWT to be used for authentication.

webhook_keystring

[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_keysstring[]

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

dev_modeboolean

Whether the Embed is initialized in developer mode.

customization_keystring

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

Response

200

idinteger
tokenstring
statusstring
user_jwtstring

Example response

{
  "id": 42197,
  "token": "3f82e2c1-7657-441a-a93d-5e8f25c7ac61",
  "status": "initialized",
  "user_jwt": "REPLACE_WITH_JWT"
}