Skip to main content
GET
/
api
/
v1
/
events
GET events instances
curl --request GET \
  --url https://app.onecodex.com/api/v1/events \
  --header 'X-API-Key: <api-key>'
[
  {
    "$uri": "/api/v1/events/a1b2c3d4e5f67890",
    "payload": {},
    "status": "retryable"
  }
]

Documentation Index

Fetch the complete documentation index at: https://developer.onecodex.com/llms.txt

Use this file to discover all available pages before exploring further.

List all available events. Note that events are generated on-demand and only listed and available programmatically if a relevant webhook subscription exists. By default, up to 30 days of events are available via this route. If you need additional historic event records, please contact us at support@onecodex.com.

Authorizations

​
X-API-Key
string
header
required

Query Parameters

​
page
integer<int32>
default:1

Page number. Defaults to 1. See Pagination for more details.

​
per_page
integer<int32>
default:50

Number of requested paginated records. Defaults to 50. See Pagination for more details.

​
sort
object

Optional Mongo-style JSON sort clause, e.g., sort={"created_at": true} to sort by created_at (descending)

​
where
object

Optional Mongo-style JSON filter clause, e.g., where={"$uri": {"$eq": "/api/v1/samples/0ee172af60e84f61"}}

Response

200 - application/json

Successful operation

​
$uri
string
Pattern: ^/api/v1/events\/[^/]+$
Example:

"/api/v1/events/a1b2c3d4e5f67890"

​
payload
object

The webhook payload.

​
status
enum<string>

The status of the webhook for the event.

Available options:
retryable,
success,
failed,
pending