Skip to content
Start here

Subscriptions

List Event Subscriptions
GET/accounts/{account_id}/event_subscriptions/subscriptions
Get Event Subscription
GET/accounts/{account_id}/event_subscriptions/subscriptions/{subscription_id}
Create Event Subscription
POST/accounts/{account_id}/event_subscriptions/subscriptions
Update Event Subscription
PATCH/accounts/{account_id}/event_subscriptions/subscriptions/{subscription_id}
Delete Event Subscription
DELETE/accounts/{account_id}/event_subscriptions/subscriptions/{subscription_id}
ModelsExpand Collapse
SubscriptionListResponse object { id, created_at, destination, 5 more }
id: string

Unique identifier for the subscription

created_at: string

When the subscription was created

formatdate-time
destination: object { queue_id, type }

Destination configuration for the subscription

queue_id: string

ID of the target queue

type: "queues.queue"

Type of destination

enabled: boolean

Whether the subscription is active

events: array of string

List of event types this subscription handles

modified_at: string

When the subscription was last modified

formatdate-time
name: string

Name of the subscription

source: object { type } or object { type } or object { type } or 5 more

Source configuration for the subscription

One of the following:
MqEventSourceImages object { type }
type: optional "images"

Type of source

MqEventSourceKV object { type }
type: optional "kv"

Type of source

MqEventSourceR2 object { type }
type: optional "r2"

Type of source

MqEventSourceSuperSlurper object { type }
type: optional "superSlurper"

Type of source

MqEventSourceVectorize object { type }
type: optional "vectorize"

Type of source

MqEventSourceWorkersAIModel object { model_name, type }
model_name: optional string

Name of the Workers AI model

type: optional "workersAi.model"

Type of source

MqEventSourceWorkersBuildsWorker object { type, worker_name }
type: optional "workersBuilds.worker"

Type of source

worker_name: optional string

Name of the worker

MqEventSourceWorkflowsWorkflow object { type, workflow_name }
type: optional "workflows.workflow"

Type of source

workflow_name: optional string

Name of the workflow

SubscriptionGetResponse object { id, created_at, destination, 5 more }
id: string

Unique identifier for the subscription

created_at: string

When the subscription was created

formatdate-time
destination: object { queue_id, type }

Destination configuration for the subscription

queue_id: string

ID of the target queue

type: "queues.queue"

Type of destination

enabled: boolean

Whether the subscription is active

events: array of string

List of event types this subscription handles

modified_at: string

When the subscription was last modified

formatdate-time
name: string

Name of the subscription

source: object { type } or object { type } or object { type } or 5 more

Source configuration for the subscription

One of the following:
MqEventSourceImages object { type }
type: optional "images"

Type of source

MqEventSourceKV object { type }
type: optional "kv"

Type of source

MqEventSourceR2 object { type }
type: optional "r2"

Type of source

MqEventSourceSuperSlurper object { type }
type: optional "superSlurper"

Type of source

MqEventSourceVectorize object { type }
type: optional "vectorize"

Type of source

MqEventSourceWorkersAIModel object { model_name, type }
model_name: optional string

Name of the Workers AI model

type: optional "workersAi.model"

Type of source

MqEventSourceWorkersBuildsWorker object { type, worker_name }
type: optional "workersBuilds.worker"

Type of source

worker_name: optional string

Name of the worker

MqEventSourceWorkflowsWorkflow object { type, workflow_name }
type: optional "workflows.workflow"

Type of source

workflow_name: optional string

Name of the workflow

SubscriptionCreateResponse object { id, created_at, destination, 5 more }
id: string

Unique identifier for the subscription

created_at: string

When the subscription was created

formatdate-time
destination: object { queue_id, type }

Destination configuration for the subscription

queue_id: string

ID of the target queue

type: "queues.queue"

Type of destination

enabled: boolean

Whether the subscription is active

events: array of string

List of event types this subscription handles

modified_at: string

When the subscription was last modified

formatdate-time
name: string

Name of the subscription

source: object { type } or object { type } or object { type } or 5 more

Source configuration for the subscription

One of the following:
MqEventSourceImages object { type }
type: optional "images"

Type of source

MqEventSourceKV object { type }
type: optional "kv"

Type of source

MqEventSourceR2 object { type }
type: optional "r2"

Type of source

MqEventSourceSuperSlurper object { type }
type: optional "superSlurper"

Type of source

MqEventSourceVectorize object { type }
type: optional "vectorize"

Type of source

MqEventSourceWorkersAIModel object { model_name, type }
model_name: optional string

Name of the Workers AI model

type: optional "workersAi.model"

Type of source

MqEventSourceWorkersBuildsWorker object { type, worker_name }
type: optional "workersBuilds.worker"

Type of source

worker_name: optional string

Name of the worker

MqEventSourceWorkflowsWorkflow object { type, workflow_name }
type: optional "workflows.workflow"

Type of source

workflow_name: optional string

Name of the workflow

SubscriptionUpdateResponse object { id, created_at, destination, 5 more }
id: string

Unique identifier for the subscription

created_at: string

When the subscription was created

formatdate-time
destination: object { queue_id, type }

Destination configuration for the subscription

queue_id: string

ID of the target queue

type: "queues.queue"

Type of destination

enabled: boolean

Whether the subscription is active

events: array of string

List of event types this subscription handles

modified_at: string

When the subscription was last modified

formatdate-time
name: string

Name of the subscription

source: object { type } or object { type } or object { type } or 5 more

Source configuration for the subscription

One of the following:
MqEventSourceImages object { type }
type: optional "images"

Type of source

MqEventSourceKV object { type }
type: optional "kv"

Type of source

MqEventSourceR2 object { type }
type: optional "r2"

Type of source

MqEventSourceSuperSlurper object { type }
type: optional "superSlurper"

Type of source

MqEventSourceVectorize object { type }
type: optional "vectorize"

Type of source

MqEventSourceWorkersAIModel object { model_name, type }
model_name: optional string

Name of the Workers AI model

type: optional "workersAi.model"

Type of source

MqEventSourceWorkersBuildsWorker object { type, worker_name }
type: optional "workersBuilds.worker"

Type of source

worker_name: optional string

Name of the worker

MqEventSourceWorkflowsWorkflow object { type, workflow_name }
type: optional "workflows.workflow"

Type of source

workflow_name: optional string

Name of the workflow

SubscriptionDeleteResponse object { id, created_at, destination, 5 more }
id: string

Unique identifier for the subscription

created_at: string

When the subscription was created

formatdate-time
destination: object { queue_id, type }

Destination configuration for the subscription

queue_id: string

ID of the target queue

type: "queues.queue"

Type of destination

enabled: boolean

Whether the subscription is active

events: array of string

List of event types this subscription handles

modified_at: string

When the subscription was last modified

formatdate-time
name: string

Name of the subscription

source: object { type } or object { type } or object { type } or 5 more

Source configuration for the subscription

One of the following:
MqEventSourceImages object { type }
type: optional "images"

Type of source

MqEventSourceKV object { type }
type: optional "kv"

Type of source

MqEventSourceR2 object { type }
type: optional "r2"

Type of source

MqEventSourceSuperSlurper object { type }
type: optional "superSlurper"

Type of source

MqEventSourceVectorize object { type }
type: optional "vectorize"

Type of source

MqEventSourceWorkersAIModel object { model_name, type }
model_name: optional string

Name of the Workers AI model

type: optional "workersAi.model"

Type of source

MqEventSourceWorkersBuildsWorker object { type, worker_name }
type: optional "workersBuilds.worker"

Type of source

worker_name: optional string

Name of the worker

MqEventSourceWorkflowsWorkflow object { type, workflow_name }
type: optional "workflows.workflow"

Type of source

workflow_name: optional string

Name of the workflow