Events — Subscribers
events_api_filters_create_endpoint
sync(subscriber_id: str, client: AuthenticatedClient, body: EventsApiFiltersCreateRequest) -> Any | EventsApiFiltersCreateResponse | FastEndpointsErrorResponse | NoneCreate a complex filter
Creates a reusable complex filter based on event field criteria. Can be referenced in subscriptions.
Parameter | Type | Default |
|---|---|---|
subscriber_id | str | required |
client | AuthenticatedClient | required |
body | EventsApiFiltersCreateRequest | required |
- body — Request to create a complex filter for a subscriber
Returns: Any | EventsApiFiltersCreateResponse | FastEndpointsErrorResponse | None
Raises:
Exception | Condition |
|---|---|
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_filters_delete_endpoint
sync_detailed(subscriber_id: str, filter_id: str, client: AuthenticatedClient) -> Response[Any]Archive (soft delete) a filter
Marks filter as archived. This is a soft delete operation. Note: Subscriptions using this filter will need to be updated.
Parameter | Type | Default |
|---|---|---|
subscriber_id | str | required |
filter_id | str | required |
client | AuthenticatedClient | required |
Returns: Response[Any]
Raises:
Exception | Condition |
|---|---|
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_filters_get_endpoint
sync(subscriber_id: str, filter_id: str, client: AuthenticatedClient) -> Any | EventsApiFiltersGetResponse | NoneGet a filter by ID
Retrieves filter details (excluding archived filters by default).
Parameter | Type | Default |
|---|---|---|
subscriber_id | str | required |
filter_id | str | required |
client | AuthenticatedClient | required |
Returns: Any | EventsApiFiltersGetResponse | None
Raises:
Exception | Condition |
|---|---|
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_filters_list_endpoint
sync(subscriber_id: str, client: AuthenticatedClient, include_archived: bool, page_size: int | None | Unset = UNSET, page_number: int | None | Unset = UNSET) -> Any | EventsApiFiltersListResponse | NoneList filters with pagination
Retrieve a paginated list of filters for a subscriber. Excludes archived filters by default.
Parameter | Type | Default |
|---|---|---|
subscriber_id | str | required |
client | AuthenticatedClient | required |
include_archived | bool | required |
page_size | int | None | Unset | UNSET |
page_number | int | None | Unset | UNSET |
Returns: Any | EventsApiFiltersListResponse | None
Raises:
Exception | Condition |
|---|---|
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_subscribers_configure_endpoint
sync(subscriber_id: str, client: AuthenticatedClient, body: EventsApiSubscribersConfigureRequest) -> Any | EventsApiSubscribersConfigureResponse | FastEndpointsErrorResponse | NoneConfigure a subscriber with a specific subscriberId
Configures delivery settings for a subscriber and transitions it to Active state. The subscriberId must be provided in the URI.
If the subscriberId does not exist, a new subscriber will be created with that ID and configured in a single step (returns 201 Created). This allows clients to use their own client-generated GUIDs.
If the subscriberId already exists, the subscriber will be reconfigured (returns 200 OK).
For RabbitMQ delivery, the subscriber should typically be created first via POST /subscribers to obtain the subscriberId needed for queue binding before calling this endpoint.
For WebSocket delivery, returns a single-use connection token for establishing the WebSocket connection.
Parameter | Type | Default |
|---|---|---|
subscriber_id | str | required |
client | AuthenticatedClient | required |
body | EventsApiSubscribersConfigureRequest | required |
- body — Request to configure a subscriber and activate event delivery. The subscriberId is provided in the URI. If it doesn't exist, a new subscriber will be created with that ID.
Returns: Any | EventsApiSubscribersConfigureResponse | FastEndpointsErrorResponse | None
Raises:
Exception | Condition |
|---|---|
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_subscribers_create_endpoint
sync(client: AuthenticatedClient, body: EventsApiSubscribersCreateRequest) -> Any | EventsApiSubscribersCreateResponse | NoneCreate a new subscriber (RabbitMQ clients only)
Creates a new subscriber in Unconfigured state and returns the subscriberId.
This endpoint is REQUIRED for RabbitMQ delivery clients who need the subscriberId to bind their queues to the subscriber-specific topic spaces (events.filtered..# and events.historical..#) BEFORE activating event flow via the Configure endpoint.
For WebHook and WebSocket delivery clients, this endpoint is OPTIONAL. These clients can call the Configure endpoint directly with a new subscriberId, which will create and configure the subscriber in a single step.
Parameter | Type | Default |
|---|---|---|
client | AuthenticatedClient | required |
body | EventsApiSubscribersCreateRequest | required |
- body — Request to create a new subscriber. This endpoint is required for RabbitMQ clients who need the subscriberId before configuring queue bindings. WebHook and WebSocket clients can skip this step and use the Configure endpoint directly.
Returns: Any | EventsApiSubscribersCreateResponse | None
Raises:
Exception | Condition |
|---|---|
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_subscribers_delete_endpoint
sync_detailed(subscriber_id: str, client: AuthenticatedClient) -> Response[Any]Archive (soft delete) a subscriber
Marks subscriber and all related entities (subscriptions, filters, delivery configuration) as archived. This is a soft delete operation.
Parameter | Type | Default |
|---|---|---|
subscriber_id | str | required |
client | AuthenticatedClient | required |
Returns: Response[Any]
Raises:
Exception | Condition |
|---|---|
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_subscribers_delivery_management_blocked_endpoint
sync(subscriber_id: str, client: AuthenticatedClient, page_number: int | None | Unset = UNSET, page_size: int | None | Unset = UNSET) -> Any | EventsApiSubscribersDeliveryManagementBlockedResponse | NoneList blocked outbox entries
Retrieves a paginated list of blocked outbox entries for a subscriber. Blocked entries have failed delivery but are not yet in the DLQ.
Parameter | Type | Default |
|---|---|---|
subscriber_id | str | required |
client | AuthenticatedClient | required |
page_number | int | None | Unset | UNSET |
page_size | int | None | Unset | UNSET |
Returns: Any | EventsApiSubscribersDeliveryManagementBlockedResponse | None
Raises:
Exception | Condition |
|---|---|
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_subscribers_delivery_management_dlq_endpoint
sync(subscriber_id: str, client: AuthenticatedClient, page_number: int | None | Unset = UNSET, page_size: int | None | Unset = UNSET) -> Any | EventsApiSubscribersDeliveryManagementDlqResponse | NoneList DLQ entries
Retrieves a paginated list of dead letter queue entries for a subscriber. DLQ entries have been moved from blocked state after timeout (if auto-DLQ enabled).
Parameter | Type | Default |
|---|---|---|
subscriber_id | str | required |
client | AuthenticatedClient | required |
page_number | int | None | Unset | UNSET |
page_size | int | None | Unset | UNSET |
Returns: Any | EventsApiSubscribersDeliveryManagementDlqResponse | None
Raises:
Exception | Condition |
|---|---|
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_subscribers_delivery_management_dlq_retry_endpoint
sync_detailed(subscriber_id: str, outbox_id: int, client: AuthenticatedClient, body: EventsApiSubscribersDeliveryManagementDlqRetryRequest) -> Response[Any]Retry a DLQ entry
Removes an entry from the DLQ and resets it for retry. The entry will be picked up by the next publisher cycle.
Parameter | Type | Default |
|---|---|---|
subscriber_id | str | required |
outbox_id | int | required |
client | AuthenticatedClient | required |
body | EventsApiSubscribersDeliveryManagementDlqRetryRequest | required |
- body — Request to retry a DLQ entry
Returns: Response[Any]
Raises:
Exception | Condition |
|---|---|
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_subscribers_delivery_management_retry_endpoint
sync_detailed(subscriber_id: str, outbox_id: int, client: AuthenticatedClient, body: EventsApiSubscribersDeliveryManagementRetryRequest) -> Response[Any]Retry a blocked outbox entry
Resets the failed state for a blocked outbox entry, allowing it to be retried. The entry will be picked up by the next publisher cycle.
Parameter | Type | Default |
|---|---|---|
subscriber_id | str | required |
outbox_id | int | required |
client | AuthenticatedClient | required |
body | EventsApiSubscribersDeliveryManagementRetryRequest | required |
- body — Request to retry a blocked outbox entry
Returns: Response[Any]
Raises:
Exception | Condition |
|---|---|
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_subscribers_delivery_management_skip_endpoint
sync_detailed(subscriber_id: str, outbox_id: int, client: AuthenticatedClient, body: EventsApiSubscribersDeliveryManagementSkipRequest) -> Response[Any]Skip a blocked outbox entry
Marks a blocked outbox entry as published without actually delivering it. This unblocks delivery for subsequent events. Use with caution - the event will not be delivered.
Parameter | Type | Default |
|---|---|---|
subscriber_id | str | required |
outbox_id | int | required |
client | AuthenticatedClient | required |
body | EventsApiSubscribersDeliveryManagementSkipRequest | required |
- body — Request to skip a blocked outbox entry
Returns: Response[Any]
Raises:
Exception | Condition |
|---|---|
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_subscribers_delivery_management_status_endpoint
sync(subscriber_id: str, client: AuthenticatedClient) -> Any | EventsApiSubscribersDeliveryManagementStatusResponse | NoneGet subscriber delivery status
Retrieves delivery status including pending, blocked, and DLQ message counts. For guaranteed mode subscribers, also shows if delivery is currently blocked.
Parameter | Type | Default |
|---|---|---|
subscriber_id | str | required |
client | AuthenticatedClient | required |
Returns: Any | EventsApiSubscribersDeliveryManagementStatusResponse | None
Raises:
Exception | Condition |
|---|---|
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_subscribers_get_endpoint
sync(subscriber_id: str, client: AuthenticatedClient) -> Any | EventsApiSubscribersGetResponse | NoneGet a subscriber by ID
Retrieves subscriber details including delivery configuration (excluding archived subscribers by default).
Parameter | Type | Default |
|---|---|---|
subscriber_id | str | required |
client | AuthenticatedClient | required |
Returns: Any | EventsApiSubscribersGetResponse | None
Raises:
Exception | Condition |
|---|---|
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_subscribers_heartbeat_endpoint
sync_detailed(subscriber_id: str, client: AuthenticatedClient) -> Response[Any]Send heartbeat for a subscriber
Updates the last heartbeat timestamp. Should be sent at least once an hour to keep subscription alive.
Parameter | Type | Default |
|---|---|---|
subscriber_id | str | required |
client | AuthenticatedClient | required |
Returns: Response[Any]
Raises:
Exception | Condition |
|---|---|
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_subscribers_list_endpoint
sync(client: AuthenticatedClient, state: EventsApiSubscribersSubscriberState | None | Unset = UNSET, include_archived: bool, page_size: int | None | Unset = UNSET, page_number: int | None | Unset = UNSET) -> Any | EventsApiSubscribersListResponse | NoneList subscribers with pagination
Retrieve a paginated list of subscribers. Excludes archived subscribers by default.
Parameter | Type | Default |
|---|---|---|
client | AuthenticatedClient | required |
state | EventsApiSubscribersSubscriberState | None | Unset | UNSET |
include_archived | bool | required |
page_size | int | None | Unset | UNSET |
page_number | int | None | Unset | UNSET |
Returns: Any | EventsApiSubscribersListResponse | None
Raises:
Exception | Condition |
|---|---|
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_subscribers_regenerate_token_endpoint
sync(subscriber_id: str, client: AuthenticatedClient, body: EventsApiSubscribersRegenerateTokenRequest) -> Any | EventsApiSubscribersRegenerateTokenResponse | NoneRegenerate WebSocket connection token
Generates a new connection token for a WebSocket subscriber. The previous token is invalidated, but any existing WebSocket connection remains active. Use this endpoint to get a new token for reconnecting after disconnection.
Parameter | Type | Default |
|---|---|---|
subscriber_id | str | required |
client | AuthenticatedClient | required |
body | EventsApiSubscribersRegenerateTokenRequest | required |
- body — Request to regenerate a WebSocket connection token
Returns: Any | EventsApiSubscribersRegenerateTokenResponse | None
Raises:
Exception | Condition |
|---|---|
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_subscriptions_create_endpoint
sync(subscriber_id: str, client: AuthenticatedClient, body: EventsApiSubscriptionsCreateRequest) -> Any | EventsApiSubscriptionsCreateResponse | FastEndpointsErrorResponse | NoneCreate a new subscription
Creates a new subscription with filtering and delivery settings for the specified subscriber.
Parameter | Type | Default |
|---|---|---|
subscriber_id | str | required |
client | AuthenticatedClient | required |
body | EventsApiSubscriptionsCreateRequest | required |
- body — Request to create a new subscription for a subscriber
Returns: Any | EventsApiSubscriptionsCreateResponse | FastEndpointsErrorResponse | None
Raises:
Exception | Condition |
|---|---|
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_subscriptions_delete_endpoint
sync_detailed(subscriber_id: str, subscription_id: str, client: AuthenticatedClient) -> Response[Any]Archive (soft delete) a subscription
Marks subscription as archived. This is a soft delete operation.
Parameter | Type | Default |
|---|---|---|
subscriber_id | str | required |
subscription_id | str | required |
client | AuthenticatedClient | required |
Returns: Response[Any]
Raises:
Exception | Condition |
|---|---|
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_subscriptions_get_endpoint
sync(subscriber_id: str, subscription_id: str, client: AuthenticatedClient) -> Any | EventsApiSubscriptionsGetResponse | NoneGet a subscription by ID
Retrieves subscription details (excluding archived subscriptions by default).
Parameter | Type | Default |
|---|---|---|
subscriber_id | str | required |
subscription_id | str | required |
client | AuthenticatedClient | required |
Returns: Any | EventsApiSubscriptionsGetResponse | None
Raises:
Exception | Condition |
|---|---|
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_subscriptions_historical_status_endpoint
sync(subscriber_id: str, subscription_id: str, client: AuthenticatedClient) -> Any | EventsApiSubscriptionsHistoricalStatusResponse | NoneGet historical backfill status for a subscription
Returns the current state and progress of historical event delivery for a subscription.
Parameter | Type | Default |
|---|---|---|
subscriber_id | str | required |
subscription_id | str | required |
client | AuthenticatedClient | required |
Returns: Any | EventsApiSubscriptionsHistoricalStatusResponse | None
Raises:
Exception | Condition |
|---|---|
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_subscriptions_list_endpoint
sync(subscriber_id: str, client: AuthenticatedClient, include_archived: bool, page_size: int | None | Unset = UNSET, page_number: int | None | Unset = UNSET) -> Any | EventsApiSubscriptionsListResponse | NoneList subscriptions with pagination
Retrieve a paginated list of subscriptions for a subscriber. Excludes archived subscriptions by default.
Parameter | Type | Default |
|---|---|---|
subscriber_id | str | required |
client | AuthenticatedClient | required |
include_archived | bool | required |
page_size | int | None | Unset | UNSET |
page_number | int | None | Unset | UNSET |
Returns: Any | EventsApiSubscriptionsListResponse | None
Raises:
Exception | Condition |
|---|---|
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_subscriptions_update_endpoint
sync(subscriber_id: str, subscription_id: str, client: AuthenticatedClient, body: EventsApiSubscriptionsUpdateRequest) -> Any | EventsApiSubscriptionsUpdateResponse | FastEndpointsErrorResponse | NoneUpdate a subscription
Updates filtering and delivery settings for an existing subscription.
Parameter | Type | Default |
|---|---|---|
subscriber_id | str | required |
subscription_id | str | required |
client | AuthenticatedClient | required |
body | EventsApiSubscriptionsUpdateRequest | required |
- body — Request to update a subscription
Returns: Any | EventsApiSubscriptionsUpdateResponse | FastEndpointsErrorResponse | None
Raises:
Exception | Condition |
|---|---|
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. |
subscriber_connect
sync_detailed(subscriber_id: UUID, client: AuthenticatedClient, token: str | Unset = UNSET) -> Response[Any]Connect via WebSocket
Establishes a WebSocket connection for receiving real-time events.
Authentication: Provide the connection token via:
- Authorization header: Bearer {connectionToken} (recommended for non-browser clients)
- Query parameter: ?token={connectionToken} (required for browser clients)
Connection Flow:
- Configure subscriber with WebSocket delivery type to get a connection token
- Connect to this endpoint with the token
- Receive connection.ready message confirming connection
- Receive events.batch messages as events occur
- Respond to ping messages with pong to maintain connection
Note: Connection tokens are single-use. After connecting, the token is invalidated. Use the regenerate token endpoint to get a new token for reconnection.
Parameter | Type | Default |
|---|---|---|
subscriber_id | UUID | required |
client | AuthenticatedClient | required |
token | str | Unset | UNSET |
Returns: Response[Any]
Raises:
Exception | Condition |
|---|---|
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. |