Skip to main content
GET
/
api
/
v1
/
events
/
{id}
GET events
curl --request GET \
  --url https://app.onecodex.com/api/v1/events/{id} \
  --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.

Get a single event by its ID.

Authorizations

​
X-API-Key
string
header
required

Path Parameters

​
id
string
required

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