Skip to content

List events

GET
/v1/pull-endpoints/{id}/events

List events stored at a pull endpoint. Returns metadata only (no payloads). Use GET /v1/pull-endpoints/{id}/events/{event_id} to fetch the full payload.

id
required
string format: uuid

Pull endpoint identifier (UUIDv7)

Example
01935abc-def0-7123-4567-890abcdef012
status
string
default: stored
Allowed values: stored fetched delivered all

Filter by event status. Default is “stored” (unacknowledged events).

event_type
string

Filter by exact event type match (e.g., “payment_intent.succeeded”).

since
string format: date-time

Return events received after this timestamp (inclusive). RFC 3339 format.

before
string format: date-time

Return events received before this timestamp (exclusive). RFC 3339 format.

limit
integer
default: 100 >= 1 <= 1000

Page size (1–1000).

cursor
string

Opaque cursor for next page.

List of events

object
data
Array<object>

Event metadata returned in list responses (no payload).

object
id
required
string format: uuid
event_type

Extracted event type (null if extraction not configured or failed)

string
nullable
Example
payment_intent.succeeded
status
required
string
Allowed values: stored fetched delivered
size_bytes
required
integer
received_at
required
string format: date-time
fetched_at
string format: date-time
nullable
delivered_at
string format: date-time
nullable
timing
required

Timing breakdown for a pull event lifecycle.

object
ingest_processing_ms

Server-side ingest processing time (validation, auth, S3 upload). Measured before the database write. Null for events ingested before timing was added.

integer
nullable
time_to_fetch_ms

Time from receipt to first customer fetch (fetched_at - received_at). Includes ingest_processing_ms server processing time; subtract it to get pure queue wait time. Null if not yet fetched.

integer
nullable
time_to_ack_ms

Time from fetch to acknowledgment (delivered_at - fetched_at). Null if not yet delivered.

integer
nullable
total_lifecycle_ms

Total time from receipt to acknowledgment (delivered_at - received_at). Null if not yet delivered.

integer
nullable
meta
object
request_id

Unique identifier for this request (useful for support)

string
Example
req_xyz123
has_more

Whether more events exist beyond the returned page.

boolean
next_cursor

Opaque cursor for the next page. Empty string when no more results.

string

Invalid request

object
error
object
code

Machine-readable error code

string
Example
INVALID_REQUEST
message

Human-readable error message

string
Example
endpoint must be a valid HTTPS URL
meta
object
request_id

Unique identifier for this request (useful for support)

string
Example
req_xyz123
Examples

Endpoint not found

{
"error": {
"code": "ENDPOINT_NOT_FOUND",
"message": "endpoint not found"
},
"meta": {
"request_id": "req_xyz123"
}
}

Unauthorized - Invalid or missing API key

object
error
object
code

Machine-readable error code

string
Example
INVALID_REQUEST
message

Human-readable error message

string
Example
endpoint must be a valid HTTPS URL
meta
object
request_id

Unique identifier for this request (useful for support)

string
Example
req_xyz123
Example
{
"error": {
"code": "UNAUTHORIZED",
"message": "Invalid or missing API key"
},
"meta": {
"request_id": "req_xyz123"
}
}
Personalize Examples

Enter your credentials to populate code examples throughout the docs.