Embed resource

The embed resource encapsulates each stage of the OneSchema import process. An embed that proceeds through the status listed below in order. Depending on your configuration, some statuses may be automatically skipped. Statuses may be used to trigger the next stage of the import process programatically.

Statuses

StatusDescription
initializedEmbed is newly created.
uploadedA csv or excel file has been uploaded to the embed.
headers_setThe header row has been set on the file uploaded to the embed.
columns_mappedColumns have been mapped on the file uploaded to the embed.
import_pendingA webhook import is in progress.
importedThe validated file has been imported.
import_failedImporting via webhook has failed.

Example JSON

{
    "id": 35231,
    "token": "835df93f-6bdb-43g8-b84e-f106c08209b2",
    "status": "columns_mapped",
    "user_jwt": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiIwYmUzMmVhMS0xYTg5LTRjNGMtOWI5Ny0zMGY4YTZjMTdhMTQiLCJ1c2VyX2lkIjoxfQ.WhdB-_CVI8OVICg8jDsuSs2XvUnlSsCkojPwDszofe8",
    "columns": [
        {
            "id": 209797,
            "name": "Country",
            "template_column_key": "country",
            "is_custom": false
        },
        {
            "id": 209808,
            "name": "Email",
            "template_column_key": "email",
            "is_custom": false
        },
        {
            "id": 209814,
            "name": "Phone Number",
            "template_column_key": "phone_number",
            "is_custom": false
        },
    ]
}