Skip to content
Cloudflare API
Start here
API Reference
Queues

Subscriptions

List Event Subscriptions
queues.subscriptions.list(SubscriptionListParams**kwargs) -> SyncV4PagePaginationArray[SubscriptionListResponse]
GET/accounts/{account_id}/event_subscriptions/subscriptions
Get Event Subscription
queues.subscriptions.get(strsubscription_id, SubscriptionGetParams**kwargs) -> SubscriptionGetResponse
GET/accounts/{account_id}/event_subscriptions/subscriptions/{subscription_id}
Create Event Subscription
queues.subscriptions.create(SubscriptionCreateParams**kwargs) -> SubscriptionCreateResponse
POST/accounts/{account_id}/event_subscriptions/subscriptions
Update Event Subscription
queues.subscriptions.update(strsubscription_id, SubscriptionUpdateParams**kwargs) -> SubscriptionUpdateResponse
PATCH/accounts/{account_id}/event_subscriptions/subscriptions/{subscription_id}
Delete Event Subscription
queues.subscriptions.delete(strsubscription_id, SubscriptionDeleteParams**kwargs) -> SubscriptionDeleteResponse
DELETE/accounts/{account_id}/event_subscriptions/subscriptions/{subscription_id}
ModelsExpand Collapse
class SubscriptionListResponse: …
id: str

Unique identifier for the subscription

created_at: datetime

When the subscription was created

formatdate-time
destination: Destination

Destination configuration for the subscription

queue_id: str

ID of the target queue

type: Literal["queues.queue"]

Type of destination

enabled: bool

Whether the subscription is active

events: List[str]

List of event types this subscription handles

modified_at: datetime

When the subscription was last modified

formatdate-time
name: str

Name of the subscription

source: Source

Source configuration for the subscription

One of the following:
class SourceMqEventSourceImages: …
type: Optional[Literal["images"]]

Type of source

class SourceMqEventSourceKV: …
type: Optional[Literal["kv"]]

Type of source

class SourceMqEventSourceR2: …
type: Optional[Literal["r2"]]

Type of source

class SourceMqEventSourceSuperSlurper: …
type: Optional[Literal["superSlurper"]]

Type of source

class SourceMqEventSourceVectorize: …
type: Optional[Literal["vectorize"]]

Type of source

class SourceMqEventSourceWorkersAIModel: …
model_name: Optional[str]

Name of the Workers AI model

type: Optional[Literal["workersAi.model"]]

Type of source

class SourceMqEventSourceWorkersBuildsWorker: …
type: Optional[Literal["workersBuilds.worker"]]

Type of source

worker_name: Optional[str]

Name of the worker

class SourceMqEventSourceWorkflowsWorkflow: …
type: Optional[Literal["workflows.workflow"]]

Type of source

workflow_name: Optional[str]

Name of the workflow

class SubscriptionGetResponse: …
id: str

Unique identifier for the subscription

created_at: datetime

When the subscription was created

formatdate-time
destination: Destination

Destination configuration for the subscription

queue_id: str

ID of the target queue

type: Literal["queues.queue"]

Type of destination

enabled: bool

Whether the subscription is active

events: List[str]

List of event types this subscription handles

modified_at: datetime

When the subscription was last modified

formatdate-time
name: str

Name of the subscription

source: Source

Source configuration for the subscription

One of the following:
class SourceMqEventSourceImages: …
type: Optional[Literal["images"]]

Type of source

class SourceMqEventSourceKV: …
type: Optional[Literal["kv"]]

Type of source

class SourceMqEventSourceR2: …
type: Optional[Literal["r2"]]

Type of source

class SourceMqEventSourceSuperSlurper: …
type: Optional[Literal["superSlurper"]]

Type of source

class SourceMqEventSourceVectorize: …
type: Optional[Literal["vectorize"]]

Type of source

class SourceMqEventSourceWorkersAIModel: …
model_name: Optional[str]

Name of the Workers AI model

type: Optional[Literal["workersAi.model"]]

Type of source

class SourceMqEventSourceWorkersBuildsWorker: …
type: Optional[Literal["workersBuilds.worker"]]

Type of source

worker_name: Optional[str]

Name of the worker

class SourceMqEventSourceWorkflowsWorkflow: …
type: Optional[Literal["workflows.workflow"]]

Type of source

workflow_name: Optional[str]

Name of the workflow

class SubscriptionCreateResponse: …
id: str

Unique identifier for the subscription

created_at: datetime

When the subscription was created

formatdate-time
destination: Destination

Destination configuration for the subscription

queue_id: str

ID of the target queue

type: Literal["queues.queue"]

Type of destination

enabled: bool

Whether the subscription is active

events: List[str]

List of event types this subscription handles

modified_at: datetime

When the subscription was last modified

formatdate-time
name: str

Name of the subscription

source: Source

Source configuration for the subscription

One of the following:
class SourceMqEventSourceImages: …
type: Optional[Literal["images"]]

Type of source

class SourceMqEventSourceKV: …
type: Optional[Literal["kv"]]

Type of source

class SourceMqEventSourceR2: …
type: Optional[Literal["r2"]]

Type of source

class SourceMqEventSourceSuperSlurper: …
type: Optional[Literal["superSlurper"]]

Type of source

class SourceMqEventSourceVectorize: …
type: Optional[Literal["vectorize"]]

Type of source

class SourceMqEventSourceWorkersAIModel: …
model_name: Optional[str]

Name of the Workers AI model

type: Optional[Literal["workersAi.model"]]

Type of source

class SourceMqEventSourceWorkersBuildsWorker: …
type: Optional[Literal["workersBuilds.worker"]]

Type of source

worker_name: Optional[str]

Name of the worker

class SourceMqEventSourceWorkflowsWorkflow: …
type: Optional[Literal["workflows.workflow"]]

Type of source

workflow_name: Optional[str]

Name of the workflow

class SubscriptionUpdateResponse: …
id: str

Unique identifier for the subscription

created_at: datetime

When the subscription was created

formatdate-time
destination: Destination

Destination configuration for the subscription

queue_id: str

ID of the target queue

type: Literal["queues.queue"]

Type of destination

enabled: bool

Whether the subscription is active

events: List[str]

List of event types this subscription handles

modified_at: datetime

When the subscription was last modified

formatdate-time
name: str

Name of the subscription

source: Source

Source configuration for the subscription

One of the following:
class SourceMqEventSourceImages: …
type: Optional[Literal["images"]]

Type of source

class SourceMqEventSourceKV: …
type: Optional[Literal["kv"]]

Type of source

class SourceMqEventSourceR2: …
type: Optional[Literal["r2"]]

Type of source

class SourceMqEventSourceSuperSlurper: …
type: Optional[Literal["superSlurper"]]

Type of source

class SourceMqEventSourceVectorize: …
type: Optional[Literal["vectorize"]]

Type of source

class SourceMqEventSourceWorkersAIModel: …
model_name: Optional[str]

Name of the Workers AI model

type: Optional[Literal["workersAi.model"]]

Type of source

class SourceMqEventSourceWorkersBuildsWorker: …
type: Optional[Literal["workersBuilds.worker"]]

Type of source

worker_name: Optional[str]

Name of the worker

class SourceMqEventSourceWorkflowsWorkflow: …
type: Optional[Literal["workflows.workflow"]]

Type of source

workflow_name: Optional[str]

Name of the workflow

class SubscriptionDeleteResponse: …
id: str

Unique identifier for the subscription

created_at: datetime

When the subscription was created

formatdate-time
destination: Destination

Destination configuration for the subscription

queue_id: str

ID of the target queue

type: Literal["queues.queue"]

Type of destination

enabled: bool

Whether the subscription is active

events: List[str]

List of event types this subscription handles

modified_at: datetime

When the subscription was last modified

formatdate-time
name: str

Name of the subscription

source: Source

Source configuration for the subscription

One of the following:
class SourceMqEventSourceImages: …
type: Optional[Literal["images"]]

Type of source

class SourceMqEventSourceKV: …
type: Optional[Literal["kv"]]

Type of source

class SourceMqEventSourceR2: …
type: Optional[Literal["r2"]]

Type of source

class SourceMqEventSourceSuperSlurper: …
type: Optional[Literal["superSlurper"]]

Type of source

class SourceMqEventSourceVectorize: …
type: Optional[Literal["vectorize"]]

Type of source

class SourceMqEventSourceWorkersAIModel: …
model_name: Optional[str]

Name of the Workers AI model

type: Optional[Literal["workersAi.model"]]

Type of source

class SourceMqEventSourceWorkersBuildsWorker: …
type: Optional[Literal["workersBuilds.worker"]]

Type of source

worker_name: Optional[str]

Name of the worker

class SourceMqEventSourceWorkflowsWorkflow: …
type: Optional[Literal["workflows.workflow"]]

Type of source

workflow_name: Optional[str]

Name of the workflow