Subscription
API reference for Subscription
Interface: Subscription
Section titled “Interface: Subscription”Complete subscription information
Properties
Section titled “Properties”createdAt
Section titled “createdAt”createdAt:
string
When this subscription was created
eventFilter
Section titled “eventFilter”eventFilter:
string
The event pattern this subscription is filtering on
eventStoreId
Section titled “eventStoreId”eventStoreId:
string
The event store this subscription is connected to
isExistingSubscription?
Section titled “isExistingSubscription?”
optionalisExistingSubscription:boolean
Whether this is an existing subscription that was found instead of creating a new one
lastProcessedEventGlobalPosition?
Section titled “lastProcessedEventGlobalPosition?”
optionallastProcessedEventGlobalPosition:number
The global position of the last successfully delivered event
message?
Section titled “message?”
optionalmessage:string
Human-readable message about the subscription operation
status
Section titled “status”status:
SubscriptionStatus
Current status of the subscription
statusDetails?
Section titled “statusDetails?”
optionalstatusDetails:SubscriptionStatusDetails
Additional details about the current status
subscriberId
Section titled “subscriberId”subscriberId:
string
The ID of the subscriber
subscriberType
Section titled “subscriberType”subscriberType:
SubscriberType
Type of subscriber receiving events
subscriptionId
Section titled “subscriptionId”subscriptionId:
string
Unique identifier for this subscription
updatedAt
Section titled “updatedAt”updatedAt:
string
When this subscription was last updated