commercetools icon

commercetools

Interact with the commercetools API. Operations are auto-generated from the official Postman collection.

Actions671

Subscription → Create Subscription

AI-generated

Summary

Create a new Subscription in the commercetools platform by specifying required fields like Key and Messages, along with optional destination configuration parameters.

Inputs

  • Key (required) — Unique identifier for the Subscription.
  • Messages (required) — JSON array specifying which message types the Subscription should listen to.
  • Destination › Type — Type of destination where messages will be sent.
  • Destination › Queue Url — The queue URL for the destination if applicable.
  • Destination › Authentication Mode — Authentication mode for the destination.
  • Destination › Region — Region for the destination.

Output shape

a single record

Returns the created Subscription object as a JSON response from the commercetools API.

Examples

Example 1: Create a Subscription with a unique key and specified message types to receive event notifications.

Provide a unique Key and a valid JSON array for Messages; optionally configure destination settings such as type, queue URL, authentication mode, and region.

Links

Discussion