Events — Endpoints

7 min

events_api_events_create_endpoint

sync(client: AuthenticatedClient, body: EventsApiEventsCreateRequest) -> Any | EventsApiEventsResponse | FastEndpointsErrorResponse | None

Create a new event

Create a new event with the provided details

Parameter	Type	Default
client	AuthenticatedClient	required
body	EventsApiEventsCreateRequest	required

body — Request model for creating a new event Example: {'type': 'OrderStarted', 'source_category': 'Integration', 'source_component': 'Other', 'source_name': 'MC12345', 'source_id': '123', 'source_created_at': '2026-08-19T00:55:34.7671781+00:00', 'payload_type': 'Integrations.Events.UserStartedOrder', 'payload': '{"orderId": 123, "action": "started"}', 'state': 'Active', 'stream_id': '123-MC12345', 'description': 'Order was started', 'triggering_event_id': None, 'source_component_extended_description': 'OrderIntegrationService', 'file_references': [{'file_name': 'run-report.pdf', 'description': 'Run execution report', 'type': 'CellarioOSBlob', 'link': 'https://myenv.cellario.cloud/api/storage/api/v1/buckets/%7BbucketName%7D/files/%7BfileId%7D'}], 'severity': None, 'user_id': None}.

Returns: Any | EventsApiEventsResponse | FastEndpointsErrorResponse | None

Raises:

Exception	Condition
UnexpectedStatus	If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
TimeoutException	If the request takes longer than Client.timeout.

events_api_events_get_endpoint

sync(client: AuthenticatedClient, id: int | None | Unset = UNSET, id_in: list[int] | None | Unset = UNSET, source_category: EventsApiEventsEventSourceCategory | None | Unset = UNSET, source_component: EventsApiEventsEventSourceComponent | None | Unset = UNSET, from_: datetime.datetime | None | Unset = UNSET, to: datetime.datetime | None | Unset = UNSET, source_created_at_from: datetime.datetime | None | Unset = UNSET, source_created_at_to: datetime.datetime | None | Unset = UNSET, type_: None | str | Unset = UNSET, type_in: list[str] | None | Unset = UNSET, state: None | str | Unset = UNSET, state_in: list[str] | None | Unset = UNSET, source_name: None | str | Unset = UNSET, source_name_in: list[str] | None | Unset = UNSET, source_id: None | str | Unset = UNSET, source_id_in: list[str] | None | Unset = UNSET, stream_id: None | str | Unset = UNSET, stream_id_in: list[str] | None | Unset = UNSET, user_id: None | str | Unset = UNSET, user_id_in: list[str] | None | Unset = UNSET, triggering_event_id: int | None | Unset = UNSET, triggering_event_id_in: list[int] | None | Unset = UNSET, payload_type: None | str | Unset = UNSET, payload_type_in: list[str] | None | Unset = UNSET, payload_has_key: list[str] | None | Unset = UNSET, payload_has_any_key: list[str] | None | Unset = UNSET, payload_match: list[str] | None | Unset = UNSET, payload_match_any: list[str] | None | Unset = UNSET, severity: EventsApiEventsEventSeverity | None | Unset = UNSET, severity_in: list[EventsApiEventsEventSeverity] | None | Unset = UNSET, page_size: int | None | Unset = UNSET, page_number: int | None | Unset = UNSET, include: list[EventsApiEventsEventIncludes] | None | Unset = UNSET) -> Any | EventsApiEventsGetPaginatedResponse | FastEndpointsErrorResponse | None

Get events list with pagination

Retrieve a paginated list of events with optional filtering.

Supports filtering by:

Event identity: id, idIn

Event metadata: type, typeIn, state, stateIn, sourceCategory, sourceComponent, sourceName, sourceNameIn, sourceId, sourceIdIn, streamId, streamIdIn, userId, userIdIn, triggeringEventId, triggeringEventIdIn, severity, severityIn

Date ranges: from/to (ReceivedAt), sourceCreatedAtFrom/sourceCreatedAtTo (SourceCreatedAt)

Payload type: payloadType, payloadTypeIn

Payload content: payloadHasKey (key existence), payloadMatch (key:value matching)

Payload filters use key:value format (e.g., payloadMatch=status:completed). Dot notation is supported for nested keys (e.g., payloadHasKey=customer.address.city).

All filters, including payload filters, are executed at the database level using PostgreSQL jsonb operators for accurate counts and complete result sets.

Parameter	Type	Default
client	AuthenticatedClient	required
id	int \| None \| Unset	UNSET
id_in	list[int] \| None \| Unset	UNSET
source_category	EventsApiEventsEventSourceCategory \| None \| Unset	UNSET
source_component	EventsApiEventsEventSourceComponent \| None \| Unset	UNSET
from_	datetime.datetime \| None \| Unset	UNSET
to	datetime.datetime \| None \| Unset	UNSET
source_created_at_from	datetime.datetime \| None \| Unset	UNSET
source_created_at_to	datetime.datetime \| None \| Unset	UNSET
type_	None \| str \| Unset	UNSET
type_in	list[str] \| None \| Unset	UNSET
state	None \| str \| Unset	UNSET
state_in	list[str] \| None \| Unset	UNSET
source_name	None \| str \| Unset	UNSET
source_name_in	list[str] \| None \| Unset	UNSET
source_id	None \| str \| Unset	UNSET
source_id_in	list[str] \| None \| Unset	UNSET
stream_id	None \| str \| Unset	UNSET
stream_id_in	list[str] \| None \| Unset	UNSET
user_id	None \| str \| Unset	UNSET
user_id_in	list[str] \| None \| Unset	UNSET
triggering_event_id	int \| None \| Unset	UNSET
triggering_event_id_in	list[int] \| None \| Unset	UNSET
payload_type	None \| str \| Unset	UNSET
payload_type_in	list[str] \| None \| Unset	UNSET
payload_has_key	list[str] \| None \| Unset	UNSET
payload_has_any_key	list[str] \| None \| Unset	UNSET
payload_match	list[str] \| None \| Unset	UNSET
payload_match_any	list[str] \| None \| Unset	UNSET
severity	EventsApiEventsEventSeverity \| None \| Unset	UNSET
severity_in	list[EventsApiEventsEventSeverity] \| None \| Unset	UNSET
page_size	int \| None \| Unset	UNSET
page_number	int \| None \| Unset	UNSET
include	list[EventsApiEventsEventIncludes] \| None \| Unset	UNSET

Returns: Any | EventsApiEventsGetPaginatedResponse | FastEndpointsErrorResponse | None

Raises:

Exception	Condition
UnexpectedStatus	If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
TimeoutException	If the request takes longer than Client.timeout.

events_api_events_search_endpoint

sync(client: AuthenticatedClient, body: EventsApiEventsSearchRequest) -> Any | EventsApiEventsGetPaginatedResponse | FastEndpointsErrorResponse | None

Search events with advanced filters

Search events using a JSON request body with support for complex payload filtering.

Supports filtering by:

Event identity: id, idIn

Event metadata: type, typeIn, state, stateIn, sourceCategory, sourceComponent, sourceName, sourceNameIn, sourceId, sourceIdIn, streamId, streamIdIn, userId, userIdIn, triggeringEventId, triggeringEventIdIn, severity, severityIn

Date ranges: from/to (ReceivedAt), sourceCreatedAtFrom/sourceCreatedAtTo (SourceCreatedAt)

Payload type: payloadType, payloadTypeIn

Payload key existence: payloadHasKeys (AND), payloadHasAnyKeys (OR)

Payload value matching: payloadMatches (AND), payloadMatchesAny (OR across all keys and values)

Free-text search: search (case-insensitive substring across type, sourceName, state, and payloadJson; OR within these fields, AND with all other filters)

Dot notation is supported for nested keys (e.g., "customer.address.city").

All filters, including payload filters, are executed at the database level using PostgreSQL jsonb operators for accurate counts and complete result sets.

Parameter	Type	Default
client	AuthenticatedClient	required
body	EventsApiEventsSearchRequest	required

body — Request body for POST /v1/events/search

Returns: Any | EventsApiEventsGetPaginatedResponse | FastEndpointsErrorResponse | None

Raises:

Exception	Condition
UnexpectedStatus	If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
TimeoutException	If the request takes longer than Client.timeout.