Events

The Events API can return different events triggered by activity on GeoSeeq. Each event response contains shared properties but has a unique payload object determined by its event type.

Event API

Currently, we have only the following endpoint to fetch events from the GeoSeeq API. Using this endpoint, applications can fetch events from projects to which they were added. In the query param 'created_at' the applications can define a date and fetch only events more recent than the provided date. This can be ideal for polling.

Get /events/{projectId}/{eventType}?created_at={date}

Common properties of event payloads

The Event object common properties describe the properties shared by all events, and each event type defines the payload properties unique to the specific event.

KEY	TYPE	DESCRIPTION

KEY	TYPE	DESCRIPTION
http://event.id	uuid	Unique id of the event
event.type	string	Type of the event, i.e., FileUpload
event.created_at	date	Date when the event occurred
http://organization.id	uuid	Unique id of the organization
http://organization.name	string	Name of the organization
http://project.id	uuid	Unique id of the project
project.name	string	Name of the project
project.privacy_level	string	Privacy level of the project. It can be public, private, or shareable.
http://actor.id	integer	Id of the actor
payload	object	The event payload object is unique to the event type. See the event types below for the event API payload objects.

ManualRun event

This is a special type of event that can be selected for GeoSeeq Apps. Users can manually trigger this event to run an application on all samples or selected samples within a project. It is completely optional to choose this type of event. We will disable the manual event on the portal if it is not selected.

KEY	TYPE	DESCRIPTION

KEY	TYPE	DESCRIPTION
sample_uuids	array	A list of sample UUIDs the app should process

UploadComplete event

This event occurs when the upload of a file is complete to a project.

KEY	TYPE	DESCRIPTION

KEY	TYPE	DESCRIPTION
http://field.id	uuid	Unique id of the field
field.name	string	Name of the field
field.stoted_data	object	Data about the uploaded file
result.id	uuid	Unique id of the result
result.name	string	Name of the result
http://sample.id	uuid	Unique id of the sample
sample.name	string	Name of the sample
sample.metadata	object	The users define the properties of this object