> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stella-commerce.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Register Webhook V1



## OpenAPI

````yaml /api-reference/openapi.json post /api/sync/v1/webhooks
openapi: 3.1.0
info:
  title: Agentic Commerce API
  description: |2-

        Agentic Commerce API - E-commerce Backend

        ## APIs

        ### Dashboard API (`/api/dashboard`)
        Authenticated endpoints for merchant management:
        - Products, Variants, Options
        - Inventory management
        - Orders and fulfillment
        - Customers
        - Collections

        ### Storefront API (`/api/storefront`)
        Public endpoints for client websites:
        - Product catalog
        - Collections
        - Cart management
        - Checkout

        ### Sync API (`/api/sync`)
        Integration endpoints for zunkiree-search:
        - Product sync
        - Availability checks
        - Order creation from AI widget
        
  version: 1.0.0
servers: []
security: []
paths:
  /api/sync/v1/webhooks:
    post:
      tags:
        - Sync v1
        - Sync v1 Webhooks
      summary: Register Webhook V1
      operationId: register_webhook_v1_api_sync_v1_webhooks_post
      parameters:
        - name: authorization
          in: header
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: Authorization
        - name: X-Stella-Site-Id
          in: header
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: X-Stella-Site-Id
        - name: X-Sync-Secret
          in: header
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: X-Sync-Secret
        - name: X-Site-ID
          in: header
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: X-Site-Id
        - name: Idempotency-Key
          in: header
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: Idempotency-Key
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WebhookRegisterRequest'
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WebhookRegistrationResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    WebhookRegisterRequest:
      properties:
        url:
          type: string
          maxLength: 2083
          minLength: 1
          format: uri
          title: Url
        events:
          items:
            type: string
          type: array
          maxItems: 100
          minItems: 1
          title: Events
        description:
          anyOf:
            - type: string
              maxLength: 255
            - type: 'null'
          title: Description
      type: object
      required:
        - url
        - events
      title: WebhookRegisterRequest
    WebhookRegistrationResponse:
      properties:
        id:
          type: string
          format: uuid
          title: Id
        url:
          type: string
          title: Url
        events:
          items:
            type: string
          type: array
          title: Events
        description:
          anyOf:
            - type: string
            - type: 'null'
          title: Description
        signing_secret_prefix:
          type: string
          title: Signing Secret Prefix
        signing_secret:
          anyOf:
            - type: string
            - type: 'null'
          title: Signing Secret
        is_active:
          type: boolean
          title: Is Active
        created_at:
          type: string
          format: date-time
          title: Created At
        deactivated_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Deactivated At
      type: object
      required:
        - id
        - url
        - events
        - signing_secret_prefix
        - is_active
        - created_at
      title: WebhookRegistrationResponse
      description: |-
        Response shape for `POST /webhooks` (creation) AND `GET /webhooks`
        listing. Note: `signing_secret` is ONLY populated on the creation
        response; list responses always omit it (server-side this is set
        to None on listing).
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError

````