> ## 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.

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


## OpenAPI

````yaml /openapi/es/rest/2026-08-27.json post /webhooks
openapi: 3.1.0
info:
  title: Commet API
  version: '2026-08-27'
  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: Markets
    description: >-
      Reusable country groups for market-specific prices and selectable price
      variants.
  - name: Offers
  - 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: Idempotency-Key
          in: header
          required: false
          description: >-
            Unique key used to safely retry this write for 24 hours without
            applying it twice.
          schema:
            type: string
            minLength: 1
            maxLength: 200
        - 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-08-27'
          example: '2026-08-27'
      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.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
                      - 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.topped_up
                      - balance.low
                      - balance.depleted
                      - 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
      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:
                $ref: '#/components/schemas/CreatedWebhook'
              example:
                id: wh_1a2b3c4d
                url: https://example.com/api/webhooks/commet
                events:
                  - customer.created
                  - subscription.activated
                  - payment.received
                description: Billing events
                isActive: true
                apiVersion: '2026-08-27'
                createdAt: '2026-09-07T12:00:00.000Z'
                object: webhook
                livemode: false
                secretKey: whsec_example_not_a_real_signing_secret
        '400':
          description: Bad request
          headers:
            X-Request-Id:
              $ref: '#/components/headers/RequestId'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error:
                  type: validation_error
                  code: validation_error
                  message: The request contains an invalid parameter.
                  doc_url: >-
                    https://commet.co/docs/api-reference/2026-08-27/errors/validation_error.md
        '401':
          description: Unauthorized
          headers:
            X-Request-Id:
              $ref: '#/components/headers/RequestId'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error:
                  type: authentication_error
                  code: unauthorized
                  message: A valid API key is required.
                  doc_url: >-
                    https://commet.co/docs/api-reference/2026-08-27/errors/unauthorized.md
        '403':
          description: Forbidden
          headers:
            X-Request-Id:
              $ref: '#/components/headers/RequestId'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error:
                  type: authentication_error
                  code: forbidden
                  message: You do not have permission to perform this operation.
                  doc_url: >-
                    https://commet.co/docs/api-reference/2026-08-27/errors/forbidden.md
        '409':
          description: Conflict
          headers:
            X-Request-Id:
              $ref: '#/components/headers/RequestId'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error:
                  type: conflict_error
                  code: idempotency_in_progress
                  message: >-
                    A request with this idempotency key is still being
                    processed.
                  doc_url: >-
                    https://commet.co/docs/api-reference/2026-08-27/errors/idempotency_in_progress.md
        '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'
              example:
                error:
                  type: rate_limit_error
                  code: rate_limited
                  message: >-
                    Too many requests. Retry after the interval specified in the
                    Retry-After header.
                  doc_url: >-
                    https://commet.co/docs/api-reference/2026-08-27/errors/rate_limited.md
        '500':
          description: Internal server error
          headers:
            X-Request-Id:
              $ref: '#/components/headers/RequestId'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error:
                  type: internal_error
                  code: internal_error
                  message: An unexpected error occurred while processing the request.
                  doc_url: >-
                    https://commet.co/docs/api-reference/2026-08-27/errors/internal_error.md
        '503':
          description: Service unavailable
          headers:
            X-Request-Id:
              $ref: '#/components/headers/RequestId'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error:
                  type: internal_error
                  code: idempotency_unavailable
                  message: >-
                    Idempotency storage is temporarily unavailable. Retry with
                    the same idempotency key.
                  doc_url: >-
                    https://commet.co/docs/api-reference/2026-08-27/errors/idempotency_unavailable.md
      x-codeSamples:
        - lang: typescript
          label: TypeScript
          source: |-
            import { Commet } from "@commet/node";

            const commet = new Commet({ apiKey: "ck_xxx" });

            const createdWebhook = await commet.webhooks.create({
              url: "https://example.com",
              events: ["subscription.created"],
            });
        - lang: python
          label: Python
          source: |-
            from commet import Commet

            commet = Commet("ck_xxx")

            created_webhook = commet.webhooks.create(
                url="https://example.com",
                events=["subscription.created"],
            )
        - lang: go
          label: Go
          source: "client, err := commet.New(\"ck_xxx\")\nif err != nil {\n\tlog.Fatal(err)\n}\nctx := context.Background()\n\ncreatedWebhook, err := client.Webhooks.Create(ctx, &commet.CreateWebhookEndpointParams{\n\tURL: \"https://example.com\",\n\tEvents: []string{\"subscription.created\"},\n})\nif err != nil {\n\tlog.Fatal(err)\n}"
        - lang: java
          label: Java
          source: |-
            import co.commet.Commet;
            import co.commet.params.CreateWebhookEndpointParams;
            import java.util.List;

            var commet = Commet.builder().apiKey("ck_xxx").build();

            var createdWebhook = commet.webhooks().create(
                CreateWebhookEndpointParams.builder("https://example.com", List.of("subscription.created")).build()
            );
        - lang: php
          label: PHP
          source: |-
            use Commet\Commet;

            $commet = new Commet('ck_xxx');

            $createdWebhook = $commet->webhooks->create(
                url: 'https://example.com',
                events: ['subscription.created'],
            );
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:
          anyOf:
            - type: string
            - type: 'null'
        isActive:
          type: boolean
        apiVersion:
          anyOf:
            - type: string
            - type: '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:
        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:
        - error
      additionalProperties: false
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key

````

## Related topics

- [Delete webhook endpoint](/docs/es/api-reference/webhooks/delete-webhook-endpoint.md)
- [Get webhook endpoint](/docs/es/api-reference/webhooks/get-webhook-endpoint.md)
- [Test webhook endpoint](/docs/es/api-reference/webhooks/test-webhook-endpoint.md)
- [Update webhook endpoint](/docs/es/api-reference/webhooks/update-webhook-endpoint.md)
- [List webhook endpoints](/docs/es/api-reference/webhooks/list-webhook-endpoints.md)


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