---
title: "Create a Subscription"
method: POST
path: "/v3/subscriptions"
tags: ["Subscriptions"]
---

# Create a Subscription

`POST /v3/subscriptions`

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

## Request body

- CreateSubscriptionV3
  - `name` string, required — Name of subscription.
  - `type` 'transform' | 'analyze' | 'route' | 'join' | 'split_collection' | 'split_item' | 'evaluation' | 'error' | 'payload_shaping' | 'enrich' | 'collection_processing', required — Type of subscription.
  - `functionName` string — Unique name of function this subscription listens to (required for function-based subscriptions).
  - `functionID` string — Unique identifier of function this subscription listens to (alternative to functionName).
  - `collectionName` string — Name of collection this subscription listens to (required for collection-based subscriptions).
  - `collectionID` string — Unique identifier of collection this subscription listens to (alternative to collectionName).
  - `disabled` boolean — Toggles whether subscription is active or not.
  - `webhookURL` string — URL bem will send webhook requests to.
  - `s3Bucket` string — S3 bucket name for syncing output data to AWS S3.
  - `s3FilePath` string — S3 file path for syncing output data to AWS S3.
  - `googleDriveFolderID` string — Google Drive folder ID for syncing output data to Google Drive.

## Response `200`

The request has succeeded.

- SubscriptionV3
  - `name` string, required — Name of subscription.
  - `subscriptionID` string, 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.
  - `functionID` string — Unique identifier of function this subscription listens to.
  - `functionName` string — Unique name of function this subscription listens to.
  - `collectionID` string — Unique identifier of collection this subscription listens to.
  - `collectionName` string — Name of collection this subscription listens to.
  - `disabled` boolean — Toggles whether subscription is active or not.
  - `webhookURL` string — URL bem will send webhook requests to.
  - `s3Bucket` string — S3 bucket name for syncing output data to AWS S3.
  - `s3FilePath` string — S3 file path for syncing output data to AWS S3.
  - `googleDriveFolderID` string — Google Drive folder ID for syncing output data to Google Drive.

---

[API](https://skmtc.dev/bem-team/apis/bem-api.md) · [All operations](https://skmtc.dev/bem-team/apis/bem-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/bem-team/bem-api/revisions/a6e4624117c6/schema)