Sign in

v36

OpenAPI 3.1.0raw.githubusercontent.com2026-08-0187270483.0 KB
Subscriptions

Create a Subscription

Creates a new subscription to listen to transform or error events.

post/v3/subscriptions

Request body

namestring required

Name of subscription.

type'transform' | 'analyze' | 'route' | 'join' | 'split_collection' | 'split_item' | 'evaluation' | 'error' | 'payload_shaping' | 'enrich' | 'collection_processing' required

Type of subscription.

functionNamestring

Unique name of function this subscription listens to (required for function-based subscriptions).

functionIDstring

Unique identifier of function this subscription listens to (alternative to functionName).

collectionNamestring

Name of collection this subscription listens to (required for collection-based subscriptions).

collectionIDstring

Unique identifier of collection this subscription listens to (alternative to collectionName).

disabledboolean

Toggles whether subscription is active or not.

webhookURLstring

URL bem will send webhook requests to.

s3Bucketstring

S3 bucket name for syncing output data to AWS S3.

s3FilePathstring

S3 file path for syncing output data to AWS S3.

googleDriveFolderIDstring

Google Drive folder ID for syncing output data to Google Drive.

Response

The request has succeeded.

namestring required

Name of subscription.

subscriptionIDstring required

The unique identifier of the subscription.

type'transform' | 'analyze' | 'route' | 'join' | 'split_collection' | 'split_item' | 'evaluation' | 'error' | 'payload_shaping' | 'enrich' | 'collection_processing' required

Type of subscription.

functionIDstring

Unique identifier of function this subscription listens to.

functionNamestring

Unique name of function this subscription listens to.

collectionIDstring

Unique identifier of collection this subscription listens to.

collectionNamestring

Name of collection this subscription listens to.

disabledboolean

Toggles whether subscription is active or not.

webhookURLstring

URL bem will send webhook requests to.

s3Bucketstring

S3 bucket name for syncing output data to AWS S3.

s3FilePathstring

S3 file path for syncing output data to AWS S3.

googleDriveFolderIDstring

Google Drive folder ID for syncing output data to Google Drive.