ONoneschema
Importer Embed Events

Get an embed event

Retrieve a single event that occurred for an embed.

get/v1/embeds/{embed_id}/events/{embed_event_id}

Request

  • Base URL
    https://api.oneschema.co
  • URL
    https://api.oneschema.co/v1/embeds/{embed_id}/events/{embed_event_id}
  • Auth
    API key in header X-API-KEY

Path parameters

embed_idinteger required

The id of the embed which contains the file.

embed_event_idinteger required

Response

200

uuidstring required

embed event uuid, eg "uuid":"event-ddbb6677-460c-4eb5-b279-c7fd3f964dcf"

event_type'embed_initialized' | 'embed_resumed' | 'embed_closed' | 'file_uploaded' | 'header_selected' | 'columns_mapped' | 'sheet_operation_performed' | 'import_submitted' | 'initial_validation_complete' | 'initial_validation_failed' | 'import_complete' | 'import_failed' required

eg "event_type":"columns_mapped"

trigger_type'user' | 'api' | 'automation' required

what kind of process triggered the event

dataEmptyResponse
created_atnumber double required

embed event timestamp as epoch seconds, eg created_at":1762463783.125189

has_snapshotboolean required

whether snapshot data are available for this event, eg: "has_snapshot":true

idinteger required

embed event id, eg: "id":417836

Changes

No recorded changes to this operation across all 1 revision of this API.