PAUSE Command

Syntax

PAUSE;CLIENT_ID=client_id;EVENT_NAME=event_type

Parameter	Description	Required	Example
CLIENT_ID	ID of the client pausing event delivery	Yes	`client-123abc`
EVENT_NAME	Type of event to pause	Yes	`user/profile/updated`

+PASS:PAUSED;EVENT_NAME=user/profile/updated

The response confirms that the event delivery has been paused and includes the event name that was paused.

-FAIL:MISSING_PARAMETERS;MESSAGE=Missing required pause request. Ensure CLIENT_ID and EVENT_NAME are passed

-FAIL:NOT_SUBSCRIBED;MESSAGE=Client is not subscribed to the specified event type

-FAIL:ALREADY_PAUSED;MESSAGE=Event delivery is already paused for this event type

PAUSE;CLIENT_ID=client-123abc;EVENT_NAME=user/profile/updated

Pause all events in a domain:

PAUSE;CLIENT_ID=client-123abc;EVENT_NAME=order/*

Paused subscriptions remain registered but do not receive events
Events published during the pause period are queued for later delivery
The client's position in the event stream is maintained during the pause
Use the CONTINUE command to resume event delivery
Pausing is temporary; use UNSUB to permanently remove a subscription
The system will check if the client has an active subscription before pausing
Wildcards can be used to pause multiple event types (e.g., order/* pauses all order events)

Last modified: 07 October 2025