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

# Create Developer Webhook

> Create a developer webhook subscription for the authenticated organization. The signing secret is returned only once.



## OpenAPI

````yaml /openapi.json post /api/v1/webhooks
openapi: 3.1.0
info:
  title: OmniCommerce API
  version: 1.0.0
  license:
    name: Proprietary
    url: https://omnicommerce.sg/terms
  description: >-
    OmniCommerce API surface for agents and developer integrations. Includes
    public endpoints (merchant discovery, product search, compare, catalog, ACO
    retrieval) and authenticated endpoints (product management via API key
    Bearer tokens).
servers:
  - url: https://omnicommerce.sg
    description: Production
  - url: http://localhost:3000
    description: Local development
security: []
tags:
  - name: agentic-checkout
    description: Merchant-fulfilled agentic checkout
    x-group: Agentic Checkout
  - name: agents
    description: agents
    x-group: Agents
  - name: analytics
    description: Sales performance across marketplaces
    x-group: Analytics
  - name: aops
    description: Agent operating procedures
    x-group: AOPs
  - name: campaigns
    description: Campaign briefs, offer windows, and marketplace runs
    x-group: Campaigns
  - name: developer-platform
    description: Authenticated developer platform APIs
    x-group: Developer Platform
  - name: documents
    description: Knowledge base document uploads
    x-group: Knowledge Base
  - name: looks
    description: AI-styled product looks
    x-group: Looks
  - name: oauth
    description: OAuth token endpoints
    x-group: OAuth
  - name: orders
    description: Workspace and agentic orders
    x-group: Orders
  - name: organizations
    description: Organization management
    x-group: Organizations
  - name: price-books
    description: Marketplace list-price markup rules
    x-group: Price Books
  - name: products
    description: Product CRUD, bulk import, enrichment, publish, and delist
    x-group: Products
  - name: promotions
    description: Central promotions and marketplace sync
    x-group: Promotions
  - name: public-agent
    description: Public agent discovery and catalog APIs
    x-group: Public Agent
  - name: returns
    description: returns
    x-group: Returns
  - name: reviews
    description: Marketplace product reviews and seller replies
    x-group: Reviews
  - name: settlements
    description: settlements
    x-group: Settlements
  - name: ucp
    description: Universal Commerce Protocol
    x-group: UCP
paths:
  /api/v1/webhooks:
    post:
      tags:
        - developer-platform
      summary: Create Developer Webhook
      description: >-
        Create a developer webhook subscription for the authenticated
        organization. The signing secret is returned only once.
      operationId: post_v1_webhooks
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              additionalProperties: false
              required:
                - url
                - events
              properties:
                organizationId:
                  type: string
                  description: >-
                    Optional for API-key requests and otherwise resolved by
                    authentication.
                url:
                  type: string
                  format: uri
                  maxLength: 2048
                  description: Public HTTP(S) callback URL.
                events:
                  type: array
                  minItems: 1
                  items:
                    type: string
                    enum:
                      - product.created
                      - product.updated
                      - product.deleted
                      - product.delisted
                      - product.price.changed
                      - product.inventory.changed
                      - product.enrichment.started
                      - product.enrichment.completed
                      - order.created
                      - order.updated
                      - order.deleted
                      - order.status.changed
                      - look.created
                      - look.deleted
                      - review.created
                      - review.updated
                      - review.status.changed
                      - settlement.created
                      - settlement.updated
                      - settlement.status.changed
                      - return.created
                      - return.updated
                      - return.status.changed
                      - account_statement.created
                      - account_statement.updated
                      - account_statement.status.changed
                      - account_statement.reconciliation.changed
                      - account_statement.transactions.synced
                      - account_statement.transactions.failed
                      - account_statement.sync.queued
                      - account_statement.sync.started
                      - account_statement.sync.completed
                      - account_statement.sync.failed
                      - account_statement.sync.unavailable
                description:
                  type: string
                  maxLength: 500
      responses:
        '201':
          description: >-
            Subscription created. The response contains the one-time signing
            secret.
        '400':
          description: Invalid event, URL, or request payload.
        '401':
          description: Unauthorized.
        '403':
          description: Missing webhooks:manage scope.
        '500':
          description: Internal server error.
      security:
        - bearerAuth: []
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key
      description: >-
        Bearer API key for server-to-server access. Session auth is also
        supported in first-party UI flows.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.