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

# List webhook endpoints

> List the webhook endpoints configured for your store.



## OpenAPI

````yaml get /v1/webhooks
openapi: 3.0.0
info:
  title: Creem API
  description: >-
    Creem is an all-in-one platform for managing subscriptions and recurring
    revenue, tailored specifically for today's SaaS companies. It enables you to
    boost revenue, enhance customer retention, and scale your operations
    seamlessly.
  version: v1
  contact:
    name: Creem Support
    url: https://creem.io
    email: support@creem.io
  license:
    name: Commercial
    url: https://creem.io/terms
  termsOfService: https://creem.io/terms
servers:
  - url: https://api.creem.io
    description: Production — live API for processing real transactions and data.
    x-speakeasy-server-id: prod
  - url: https://test-api.creem.io
    description: Test — sandbox API for development and testing with no real charges.
    x-speakeasy-server-id: test
security: []
tags: []
externalDocs:
  description: Creem Documentation
  url: https://docs.creem.io
paths:
  /v1/webhooks:
    get:
      tags:
        - Webhooks
      summary: List webhook endpoints
      description: List the webhook endpoints configured for your store.
      operationId: listWebhooks
      parameters:
        - name: page_number
          required: false
          in: query
          description: The page number for pagination.
          schema:
            default: 1
            example: 1
            type: number
        - name: page_size
          required: false
          in: query
          description: The number of items per page.
          schema:
            default: 10
            example: 10
            type: number
      responses:
        '200':
          description: Successfully retrieved the list of webhook endpoints
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WebhookListEntity'
        '400':
          description: Bad Request - Invalid input parameters
        '401':
          description: Unauthorized - Invalid or missing API key
        '404':
          description: Not Found - Resource does not exist
      security:
        - ApiKey: []
components:
  schemas:
    WebhookListEntity:
      type: object
      properties:
        items:
          description: List of webhook endpoints
          items:
            $ref: '#/components/schemas/WebhookEntity'
          type: array
        pagination:
          description: Pagination details for the list
          allOf:
            - $ref: '#/components/schemas/PaginationEntity'
      required:
        - items
        - pagination
    WebhookEntity:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier for the object.
        mode:
          $ref: '#/components/schemas/EnvironmentMode'
        object:
          type: string
          description: >-
            A string representing the object’s type. Objects of the same type
            share the same value.
          example: webhook
        store_id:
          type: string
          description: The store this webhook endpoint belongs to.
          example: sto_1234567890
        name:
          type: string
          description: A human-readable label for the endpoint.
          example: Production billing events
          nullable: true
        url:
          type: string
          description: The HTTPS URL Creem delivers events to.
          example: https://example.com/webhooks/creem
        status:
          $ref: '#/components/schemas/WebhookStatus'
          example: enabled
        events:
          type: array
          example:
            - checkout.completed
            - subscription.paid
          items:
            $ref: '#/components/schemas/WebhookEventType'
        secret:
          type: string
          description: >-
            The signing secret used to verify delivery signatures. Only returned
            when the endpoint is created; retrieve it later via the secret
            endpoint.
          example: whsec_xxxxxxxxxxxxxxxxxxxx
      required:
        - id
        - mode
        - object
        - store_id
        - name
        - url
        - status
        - events
    PaginationEntity:
      type: object
      properties:
        total_records:
          type: number
          description: Total number of records in the list
          example: 0
        total_pages:
          type: number
          description: Total number of pages available
          example: 0
        current_page:
          type: number
          description: The current page number
          example: 1
        next_page:
          type: number
          description: The next page number, or null if there is no next page
          example: 2
          nullable: true
        prev_page:
          type: number
          description: The previous page number, or null if there is no previous page
          example: null
          nullable: true
      required:
        - total_records
        - total_pages
        - current_page
        - next_page
        - prev_page
    EnvironmentMode:
      type: string
      description: String representing the environment.
      enum:
        - test
        - prod
        - sandbox
    WebhookStatus:
      type: string
      description: >-
        Whether the endpoint receives deliveries. Disabled endpoints keep their
        configuration but receive nothing.
      enum:
        - enabled
        - disabled
    WebhookEventType:
      type: string
      description: >-
        Event types delivered to this endpoint. An empty list means every event
        type.
      enum:
        - checkout.completed
        - refund.created
        - dispute.created
        - subscription.active
        - subscription.trialing
        - subscription.canceled
        - subscription.scheduled_cancel
        - subscription.paid
        - subscription.expired
        - subscription.unpaid
        - subscription.update
        - subscription.past_due
        - subscription.paused
        - customer_credits.exhausted
        - credits.granted
        - credits.consumed
        - credits.auto_recharged
  securitySchemes:
    ApiKey:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        API key for authentication. You can find your API key in the Creem
        dashboard under Settings > API Keys.

````