Events
Events Management
Query and inspect your event history
Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
Query and inspect your event history
GET /v1/events
Authorization: Bearer <jwt>
| Parameter | Type | Default | Maximum | Description |
|---|---|---|---|---|
page | integer | 0 | — | Zero-indexed page number |
size | integer | 20 | 1000 | Number of events per page |
curl "https://api.eldrstream.com/v1/events?page=0&size=50" \
-H "Authorization: Bearer <jwt>"
{
"events": [
{
"eventId": "evt_01J8ZXQY5H4KCZP3M2R...",
"tenantId": "a3f8bc1d2e",
"state": "DELIVERED",
"ingestionTimestamp": "2025-01-15T10:30:00Z",
"targetWebhook": "https://example.com/hooks/eldrstream",
"errorReason": null,
"originalPayload": {
"event_type": "order.created",
"order_id": "ORD-1001"
}
}
],
"total": 142
}
| Field | Description |
|---|---|
events | Array of event objects for the current page |
total | Total number of events in your account |
| Field | Type | Description |
|---|---|---|
eventId | string | Unique event identifier |
tenantId | string | Your tenant ID |
state | string | DELIVERED or FAILED |
ingestionTimestamp | ISO 8601 | When EldrStream received the event |
targetWebhook | string | The webhook URL the event was dispatched to |
errorReason | string | null | Human-readable failure reason, if applicable |
originalPayload | object | null | The original payload you sent |
GET /v1/events/{id}
| Parameter | Description |
|---|---|
id | The eventId returned when the event was ingested |
curl "https://api.eldrstream.com/v1/events/evt_01J8ZXQY5H4KCZP3M2R..." \
-H "Authorization: Bearer <jwt>"
[
{
"eventId": "evt_01J8ZXQY5H4KCZP3M2R...",
"tenantId": "a3f8bc1d2e",
"state": "DELIVERED",
"ingestionTimestamp": "2025-01-15T10:30:00Z",
"targetWebhook": "https://example.com/hooks/eldrstream",
"errorReason": null,
"originalPayload": {
"event_type": "order.created",
"order_id": "ORD-1001"
}
}
]
| Status | Meaning |
|---|---|
200 OK | Event found |
404 Not Found | No event with that ID in your account |
GET /v1/events/state/{state}
| Parameter | Values | Description |
|---|---|---|
state | DELIVERED, FAILED | The delivery state to filter by |
| Parameter | Type | Default | Maximum | Description |
|---|---|---|---|---|
page | integer | 0 | — | Zero-indexed page number |
size | integer | 20 | 1000 | Number of events per page |
curl "https://api.eldrstream.com/v1/events/state/FAILED?page=0&size=100" \
-H "Authorization: Bearer <jwt>"
{
"events": [
{
"eventId": "evt_01J8AABB2C...",
"tenantId": "a3f8bc1d2e",
"state": "FAILED",
"ingestionTimestamp": "2025-01-14T08:12:44Z",
"targetWebhook": "https://example.com/hooks/eldrstream",
"errorReason": "HTTP 503 from https://example.com/hooks/eldrstream",
"originalPayload": { "event_type": "shipment.dispatched" }
}
],
"total": 3
}