Dashboard Importer

Start importer sessions directly from the OneSchema dashboard.

Dashboard Importer lets your team start a OneSchema Importer session directly from the OneSchema dashboard. This is useful for operational imports where a teammate needs to upload a file without embedding the SDK in another application.

Dashboard-started imports use the same templates, environments, validation rules, and import destinations as embedded Importer sessions. Every session appears in the Import Activity feed after it is started.

Before you begin

To start an import from the dashboard, you need:

  • A OneSchema dashboard user with access to the Import Activity page.
  • A template for the data you want to import.
  • A pushed template snapshot in the environment you want to use. If the selected template has not been pushed to the selected environment, the dashboard will show No pushed changes for that environment and will not start the import.
  • An import destination, if you want OneSchema to send the imported data to your system automatically. If you only want to create an Import Activity record and retrieve results later, you can choose no destination.

Start an import

  1. In the OneSchema dashboard, open Import Activity.
  2. Click Start an import.
  3. Select the template that should validate the uploaded file.
  4. Select the environment for the import. The Production environment is selected by default.
  5. Choose an import destination:
    • No destination (Imports page only) creates a metadata-only import record. Use this when you want to review the import in OneSchema and retrieve the data later from Import Activity or the API.
    • A configured Importer Webhook sends imported data to that webhook after the user finishes the importer flow.
  6. Click Start import.
  7. Upload, map, review, and finalize the file in the importer.

When the import succeeds, OneSchema closes the importer and opens the new import's detail page in Import Activity.

Import destinations

Dashboard Importer supports two destination modes.

No destination

Choose No destination (Imports page only) when you do not want OneSchema to immediately send row data to a webhook. OneSchema records the completed import in Import Activity with metadata about the session, and you can retrieve results later from the dashboard or API.

Importer Webhook

Choose an Importer Webhook when the finalized rows should be delivered to your system automatically. The dropdown shows the webhook key and URL for each configured webhook.

To add or edit webhook destinations, see Configuring Importer Webhook.

Notes and limits

  • Dashboard Importer always launches a production-mode importer session.
  • Dashboard Importer does not save abandoned importer sessions. If the user cancels or closes the importer, they can start a new import from Import Activity.
  • The dashboard generates the user JWT automatically for the selected environment. You do not need to generate a JWT manually when starting an import from the dashboard.
  • If an import fails before launch, check that the selected template has been pushed to the selected environment and that the dashboard user has access to the selected template and import destination.

Related docs