> ## Documentation Index > Fetch the complete documentation index at: https://sendcloud.dev/llms.txt > Use this file to discover all available pages before exploring further. # Create a subscription > Create a new subscription that routes events of a specific type to a connection. Create a subscription that routes a specific event type to a connection for delivery. A subscription links an event type (e.g., `parcels.event.created`) to a connection endpoint. When the event occurs, the event payload is delivered to the connection's configured endpoint. Subscriptions are active by default. Set `is_active` to `false` to create a paused subscription. ## OpenAPI ````yaml /.openapi/v3/event-subscriptions/openapi.yaml post /event-subscriptions/subscriptions openapi: 3.1.0 info: title: Event Subscriptions API version: 3.0.0 description: >- **BETA** - The Event Subscriptions API allows you to subscribe to parcel events and have them delivered to external endpoints such as webhooks or Klaviyo. This API uses a two-part model: - **Connections** define _where_ events are delivered (e.g., a webhook URL or a Klaviyo account). - **Subscriptions** define _which_ events are routed to a connection. All resources are scoped to the authenticated user's organization. contact: name: Sendcloud API Support email: contact@sendcloud.com license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html servers: - url: https://panel.sendcloud.sc/api/v3 description: Sendcloud Production security: [] tags: - name: Connections - name: Subscriptions - name: OAuth2 - name: Broadcast - name: Events paths: /event-subscriptions/subscriptions: post: tags: - Subscriptions summary: Create a subscription description: >- Create a new subscription that routes events of a specific type to a connection. operationId: sc-public-v3-scp-post-create_subscription requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/subscription-create-request' examples: CreateSubscription: summary: Create a subscription for parcel events value: connection_id: 1 event_type: parcels.event.created is_active: true responses: '201': description: Created content: application/json: schema: description: Subscription created type: object properties: data: $ref: '#/components/schemas/subscription' examples: SubscriptionCreated: summary: Subscription created value: data: id: 1 connection_id: 1 event_type: parcels.event.created is_active: true created_at: '2026-01-15T11:00:00Z' updated_at: '2026-01-15T11:00:00Z' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/errors' examples: ValidationError: summary: Validation error value: errors: - detail: This field is required. status: '400' source: pointer: /data/connection_id code: required '429': description: Throttled security: - HTTPBasicAuth: [] - OAuth2ClientCreds: [] components: schemas: subscription-create-request: title: Create Subscription request description: Request body for creating a new subscription. type: object required: - connection_id - event_type properties: connection_id: type: integer format: int64 minimum: 1 description: The identifier of the connection to deliver events to. event_type: type: string description: The type of event to subscribe to. enum: - parcels.event.created is_active: type: boolean description: >- Whether the subscription should be active immediately. Defaults to `true`. default: true subscription: title: Subscription description: >- A subscription routes a specific event type to a connection for delivery. type: object properties: id: type: integer format: int64 minimum: 1 description: Unique identifier of the subscription. connection_id: type: integer format: int64 minimum: 1 description: >- The identifier of the connection this subscription delivers events to. event_type: type: string description: The type of event this subscription listens for. enum: - parcels.event.created is_active: type: boolean description: Whether the subscription is currently active and delivering events. created_at: type: string format: date-time description: >- The date and time when the subscription was created, in ISO 8601 format. updated_at: type: string format: date-time description: >- The date and time when the subscription was last updated, in ISO 8601 format. errors: title: Errors type: object description: A standardized format for errors in JSON:API responses. properties: errors: type: - array - object items: type: object allOf: - $ref: '#/components/schemas/ErrorObject' required: - status - code - detail ErrorObject: title: Error type: object description: Error in a JSON:API error format properties: id: type: string description: A unique identifier for the error. links: type: object description: >- A set of hyperlinks that provide additional information about the error. properties: about: type: string description: A URL that provides additional information about the error. status: type: string format: int32 description: The HTTP status code of the error. minLength: 1 code: type: string description: A unique error code for the error, in snake case format. minLength: 1 enum: - unknown_field - invalid - forbidden - invalid_choice - min_value - 'null' - not_found - required - not_a_list - non_field_errors - authentication_failed - validation_error - parcel_announcement_error title: type: string description: A short, human-readable summary of the error. minLength: 1 detail: type: string description: A human-readable explanation of the error. minLength: 1 source: type: object description: >- An object that identifies the source of the error within the request payload. properties: pointer: type: string description: >- A `JSON` pointer to the location of the error within the request payload. parameter: type: string description: The name of the `query` parameter that caused the error. header: type: string description: The name of the `header` parameter that caused the error. meta: type: object description: Additional metadata about the error. securitySchemes: HTTPBasicAuth: type: http description: >- Basic Authentication using API key and secrets is currently the main authentication mechanism. scheme: basic OAuth2ClientCreds: type: oauth2 description: >- OAuth2 is a standardized protocol for authorization that allows users to share their private resources stored on one site with another site without having to provide their credentials. OAuth2 Client Credentials Grant workflow. This workflow is typically used for server-to-server interactions that require authorization to access specific resources. flows: clientCredentials: tokenUrl: https://account.sendcloud.com/oauth2/token/ scopes: api: Default OAuth scope required to access Sendcloud API. ````