Skip to content

Get subscription details

GET
/api/event-stores/{eventStoreName}/subscriptions/{subscriptionId}

Returns details of a specific event subscription

eventStoreName
required

Event store name (automatically scoped to your organization)

string

Event store name (automatically scoped to your organization)

subscriptionId
required

Unique identifier for the subscription

string

Unique identifier for the subscription

Subscription details

object
subscriptionId
required

Unique identifier for this subscription

string
status
required

Current status of the subscription

string
Allowed values: ACTIVE SUSPENDED ERROR INITIALIZING DELETED
statusDetails

Additional details about the current status

object
lastError
string
lastErrorAt
string format: date-time
retryCount
number
nextRetryAt
string format: date-time
eventStoreName
required

The event store name this subscription is connected to

string
eventFilter
required

The event pattern this subscription is filtering on

string
subscriberId
required

The ID of the subscriber

string
subscriberType
required

The type of subscriber to receive events

string
Allowed values: durable_object webhook queue cloudflare_workflow websocket
createdAt
required

When this subscription was created

string format: date-time
updatedAt
required

When this subscription was last updated

string format: date-time
lastProcessedEventGlobalPosition

The global position of the last successfully delivered event

number
isExistingSubscription

Whether this is an existing subscription that was found instead of creating a new one

boolean
message

Human-readable message about the subscription operation

string
Examples
{
"subscriptionId": "sub_123456",
"status": "active",
"eventStoreName": "production",
"eventFilter": "user.*",
"subscriberId": "webhook-user-events",
"subscriberType": "webhook",
"createdAt": "2023-10-25T15:30:45Z",
"lastProcessedEventGlobalPosition": 1234
}

Unauthorized: Organization ID not found in authentication context

object
error
required

Error type

string
message
required

Human-readable error message

string
details

Additional error details

object
key
additional properties
nullable
Examples
{
"error": "UNAUTHORIZED",
"message": "Unauthorized"
}

Subscription or event store not found

object
error
required

Error type

string
message
required

Human-readable error message

string
details

Additional error details

object
key
additional properties
nullable
Examples
{
"error": "SUBSCRIPTION_NOT_FOUND",
"message": "The specified subscription does not exist",
"details": {
"eventStoreName": "production",
"subscriptionId": "sub_nonexistent"
}
}

Internal server error

object
error
required

Error type

string
message
required

Human-readable error message

string
details

Additional error details

object
key
additional properties
nullable