List event store subscriptions

GET

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

• Production

Returns a list of all subscriptions for a specific event store

Authorizations

• Bearer

Parameters

Path Parameters

eventStoreName

required

Event store name (automatically scoped to your organization)

string

Event store name (automatically scoped to your organization)

Query Parameters

subscriberType

Filter results by subscriber type

string

Allowed values: durable_object webhook queue cloudflare_workflow websocket

Filter results by subscriber type

eventFilter

Filter results by event filter pattern

string

Filter results by event filter pattern

limit

Maximum number of results to return

string

Maximum number of results to return

offset

Number of results to skip

string

Number of results to skip

Responses

200

List of subscriptions

object

subscriptions

required

Array<object>

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

totalCount

required

number

Examples

{
  "subscriptions": [
    {
      "subscriptionId": "sub_123456",
      "status": "active",
      "eventStoreName": "production",
      "eventFilter": "user.*",
      "subscriberId": "webhook-user-events",
      "subscriberType": "webhook",
      "createdAt": "2023-10-25T15:30:45Z",
      "lastProcessedEventGlobalPosition": 1234
    },
    {
      "subscriptionId": "sub_789012",
      "status": "active",
      "eventStoreName": "production",
      "eventFilter": "order.*",
      "subscriberId": "order-processor",
      "subscriberType": "durable_object",
      "createdAt": "2023-10-26T09:15:30Z",
      "lastProcessedEventGlobalPosition": 5678
    }
  ],
  "totalCount": 2
}

401

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"
}

404

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": "EVENT_STORE_NOT_FOUND",
  "message": "The specified event store does not exist",
  "details": {
    "eventStoreName": "nonexistent"
  }
}

500

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