Sign in

v36

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

List Subscriptions

get/v3/subscriptions

Query parameters

functionNamesstring[]

Filters to subscriptions linked to included array of function names.

limitinteger

This specifies a limit on the number of objects to return, ranging between 1 and 100.

sortOrder'asc' | 'desc'

Specifies sorting behavior. The two options are asc and desc to sort ascending and descending respectively, with default sort being ascending. Paging works in both directions.

startingAfterstring

A cursor to use in pagination. startingAfter is a task ID that defines your place in the list. For example, if you make a list request and receive 50 objects, ending with sub_2c9AXIj48cUYJtCuv1gsQtHGDzK, your subsequent call can include startingAfter=sub_2c9AXIj48cUYJtCuv1gsQtHGDzK to fetch the next page of the list.

endingBeforestring

A cursor to use in pagination. endingBefore is a task ID that defines your place in the list. For example, if you make a list request and receive 50 objects, starting with sub_2c9AXIj48cUYJtCuv1gsQtHGDzK, your subsequent call can include endingBefore=sub_2c9AXIj48cUYJtCuv1gsQtHGDzK to fetch the previous page of the list.

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.