Skip to main content

kobana inbox system-events

Commands of kobana inbox system-events. Every global option (Global options) applies here.

CommandHTTPDescription
system-events listGET /v1/system-eventsList system events
system-events getGET /v1/system-events/{id}Get system event

system-events list​

List system events

kobana inbox system-events list [OPTIONS]

GET /v1/system-events

Keyset-paginated. Filters are typed query params (field=value, field[op]=value); unknown filters, unsortable fields and malformed values are rejected with 400 VALIDATION_ERROR.

Query parameters

NameTypeRequiredDescription
limitintegerno
cursorstringnoOpaque cursor returned in meta.next_cursor of the previous page.
sort_bystringnoField to order by. Allowed: created_at, slug. Without it the order is created_at descending. Values: created_at, slug.
sort_orderstringnoasc (default) or desc. Needs sort_by. Values: asc, desc.
slugstringnoEquality. Also slug[in]=a,b.
inbox_idstringnoEquality. Also inbox_id[in]=a,b.
email_idstringnoEquality. Also email_id[in]=a,b.
created_atstringnoEquality. Also created_at[in]=a,b and created_at[gt|gte|lt|lte].
created_at[gte]stringno
created_at[lte]stringno

Headers

NameTypeRequiredDescription
x-origin-shared-secretstringnoShared secret between CloudFront and the origin. Required in production; ignored in development unless CF_ORIGIN_SHARED_SECRET is set.

Responses

HTTPDescription
200Page of results.
400Body failed Zod validation. error.details carries formErrors/fieldErrors.
404Resource not found or filtered out by soft-delete.

system-events get​

Get system event

kobana inbox system-events get [ID] [OPTIONS]

GET /v1/system-events/{id}

Path arguments: id

Headers

NameTypeRequiredDescription
x-origin-shared-secretstringnoShared secret between CloudFront and the origin. Required in production; ignored in development unless CF_ORIGIN_SHARED_SECRET is set.

Responses

HTTPDescription
200Success.
404Resource not found or filtered out by soft-delete.