Events — Admin

6 min

events_api_admin_outbox_get_failed_endpoint

sync(client: AuthenticatedClient, delivery_channel: EventsApiEventsDeliveryChannel | None | Unset = UNSET, from_: datetime.datetime | None | Unset = UNSET, to: datetime.datetime | None | Unset = UNSET, page_number: int | None | Unset = UNSET, page_size: int | None | Unset = UNSET) -> Any | EventsApiAdminOutboxGetFailedResponse | None

Get failed outbox messages

Retrieve a paginated list of permanently failed outbox messages. These messages have exceeded the maximum retry attempts and require manual intervention.

Parameter	Type	Default
client	AuthenticatedClient	required
delivery_channel	EventsApiEventsDeliveryChannel \| None \| Unset	UNSET
from_	datetime.datetime \| None \| Unset	UNSET
to	datetime.datetime \| None \| Unset	UNSET
page_number	int \| None \| Unset	UNSET
page_size	int \| None \| Unset	UNSET

Returns: Any | EventsApiAdminOutboxGetFailedResponse | 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_admin_outbox_retry_endpoint

sync(id: str, client: AuthenticatedClient) -> Any | EventsApiAdminOutboxRetryResponse | None

Retry a failed outbox message

Reset a permanently failed outbox message to allow the background publisher to retry. This resets the PublishFailed flag and AttemptCount, allowing the message to be processed again.

Parameter	Type	Default
id	str	required
client	AuthenticatedClient	required

Returns: Any | EventsApiAdminOutboxRetryResponse | 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_admin_perf_outbox_timing_endpoint

sync(client: AuthenticatedClient, channel: EventsApiEventsDeliveryChannel | None | Unset = UNSET, from_: datetime.datetime | None | Unset = UNSET, to: datetime.datetime | None | Unset = UNSET, limit: int | None | Unset = UNSET) -> Any | EventsApiAdminPerfOutboxTimingResponse | None

Get outbox pipeline timing statistics

Returns percentile latency stats for each pipeline segment, grouped by delivery channel. Used to identify performance bottlenecks.

Parameter	Type	Default
client	AuthenticatedClient	required
channel	EventsApiEventsDeliveryChannel \| None \| Unset	UNSET
from_	datetime.datetime \| None \| Unset	UNSET
to	datetime.datetime \| None \| Unset	UNSET
limit	int \| None \| Unset	UNSET

Returns: Any | EventsApiAdminPerfOutboxTimingResponse | 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.