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

# Create webhook endpoint

> Create a new webhook endpoint. The response includes the signing secret which is only returned once.

> [!NOTE]
>
> This reference describes API version `2026-05-25`. Send `Commet-Version: 2026-05-25` with your request.


## OpenAPI

````yaml /openapi/es/rest/2026-05-25.json post /webhooks
openapi: 3.1.0
info:
  title: Commet API
  version: '2026-05-25'
  description: Billing and payments API for SaaS and AI products.
servers:
  - url: https://commet.co/api/v1
security:
  - ApiKeyAuth: []
tags:
  - name: Test Clock
    description: >-
      Simulate the passage of time in sandbox to test billing flows. Mirrors
      Stripe test clocks: forward-only and sandbox-only.
  - name: Customers
  - name: Subscriptions
  - name: Plans
  - name: Promo Codes
  - name: Features
  - name: Usage
  - name: Seats
  - name: Quota
  - name: Add-ons
  - name: Portal
  - name: Credit Packs
  - name: Plan Groups
  - name: Invoices
  - name: Payments
    description: >-
      One-time payments with no subscription or plan. Charge a customer's saved
      payment method off-session, or create a payment link the customer opens to
      pay. Tax, invoice, and receipt are handled automatically.
  - name: Transactions
  - name: Webhooks
  - name: API Keys
  - name: Payouts
    description: >-
      Withdraw available balance to your bank and manage the payout account
      (verification + destination bank accounts).
  - name: Provisioning
    description: >-
      Take ownership of an organization an agent provisioned headlessly. The
      agent holds the API keys from the start; a human claims the account
      through a claim link.
paths:
  /webhooks:
    post:
      tags:
        - Webhooks
      summary: Create webhook endpoint
      description: >-
        Create a new webhook endpoint. The response includes the signing secret
        which is only returned once.
      operationId: create-webhook-endpoint
      parameters:
        - name: Commet-Version
          in: header
          required: false
          description: >-
            API version used by this reference. Send this header to select this
            contract explicitly.
          schema:
            type: string
            default: '2026-05-25'
          example: '2026-05-25'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                url:
                  type: string
                  minLength: 1
                  format: uri
                events:
                  minItems: 1
                  type: array
                  items:
                    type: string
                    enum:
                      - subscription.created
                      - subscription.activated
                      - subscription.reactivated
                      - subscription.pause_scheduled
                      - subscription.pause_updated
                      - subscription.pause_revoked
                      - subscription.paused
                      - subscription.resumed
                      - subscription.resume_failed
                      - subscription.canceled
                      - subscription.updated
                      - subscription.plan_changed
                      - subscription.cancellation_scheduled
                      - subscription.cancellation_revoked
                      - subscription.plan_change_scheduled
                      - subscription.plan_change_revoked
                      - subscription.version_changed
                      - subscription.version_change_canceled
                      - subscription.past_due
                      - trial.started
                      - trial.converted
                      - trial.expired
                      - trial.will_end
                      - trial.checkout_ready
                      - checkout.ready
                      - payment.received
                      - payment.failed
                      - payment.recovered
                      - payment.retry_failed
                      - payment.refunded
                      - payment.disputed
                      - payment.dispute_resolved
                      - payment_link.created
                      - payment_link.completed
                      - payment_link.failed
                      - payment_link.canceled
                      - invoice.created
                      - invoice.voided
                      - invoice.overdue
                      - invoice.upcoming
                      - payment_method.attached
                      - payment_method.updated
                      - payment_method.detached
                      - customer.created
                      - customer.updated
                      - customer.state_changed
                      - plan_grant.created
                      - plan_grant.updated
                      - plan_grant.expired
                      - plan_grant.revoked
                      - credits.granted
                      - credits.purchased
                      - credits.low
                      - credits.depleted
                      - credits.expired
                      - balance.granted
                      - balance.topped_up
                      - balance.low
                      - balance.depleted
                      - balance.expired
                      - quota.threshold_reached
                      - quota.exceeded
                      - seats.updated
                      - seats.limit_reached
                      - addon.activated
                      - addon.deactivated
                      - usage.recorded
                      - payout.available
                      - payout.created
                      - payout.paid
                      - payout.failed
                description:
                  type: string
                apiVersion:
                  type: string
              required:
                - url
                - events
              additionalProperties: false
      responses:
        '201':
          description: Success
          headers:
            X-Request-Id:
              $ref: '#/components/headers/RequestId'
            RateLimit-Limit:
              description: Maximum number of requests allowed in the current window.
              schema:
                type: string
            RateLimit-Remaining:
              description: Requests remaining in the current window.
              schema:
                type: string
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    const: true
                  data:
                    $ref: '#/components/schemas/CreatedWebhook'
                required:
                  - success
                  - data
        '400':
          description: Bad request
          headers:
            X-Request-Id:
              $ref: '#/components/headers/RequestId'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized
          headers:
            X-Request-Id:
              $ref: '#/components/headers/RequestId'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: Too many requests
          headers:
            X-Request-Id:
              $ref: '#/components/headers/RequestId'
            RateLimit-Limit:
              description: Maximum number of requests allowed in the current window.
              schema:
                type: string
            RateLimit-Remaining:
              description: Requests remaining in the current window.
              schema:
                type: string
            RateLimit-Reset:
              description: Seconds until the rate limit window resets.
              schema:
                type: string
            Retry-After:
              description: Seconds to wait before retrying the request.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal server error
          headers:
            X-Request-Id:
              $ref: '#/components/headers/RequestId'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  headers:
    RequestId:
      description: >-
        Server-generated identifier that correlates this response with Platform
        logs.
      schema:
        type: string
        format: uuid
  schemas:
    CreatedWebhook:
      type: object
      properties:
        id:
          type: string
        url:
          type: string
        events:
          type: array
          items:
            type: string
        description:
          type:
            - string
            - 'null'
        isActive:
          type: boolean
        apiVersion:
          type:
            - string
            - 'null'
        createdAt:
          type: string
          format: date-time
        secretKey:
          type: string
        object:
          type: string
          const: webhook
        livemode:
          type: boolean
      required:
        - id
        - url
        - events
        - description
        - isActive
        - apiVersion
        - createdAt
        - secretKey
        - object
        - livemode
      additionalProperties: false
    ErrorResponse:
      type: object
      properties:
        success:
          type: boolean
          const: false
        error:
          type: object
          properties:
            type:
              type: string
            code:
              type: string
            message:
              type: string
            param:
              type: string
            details: {}
            doc_url:
              type: string
          required:
            - type
            - code
            - message
            - doc_url
          additionalProperties: false
      required:
        - success
        - error
      additionalProperties: false
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key

````

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