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

# List Event Types

> List the events you can subscribe to, with payload schemas and examples.

Returns every event type Prava can send, with its payload schema, an example and the current `schema_version`. Use the `type` values in an endpoint's `events` list.

See [Event types](https://docs.prava.space/webhooks/events.md) for when each event is sent.


## OpenAPI

````yaml api-reference/openapi.json GET /v1/webhook-event-types
openapi: 3.1.0
info:
  title: Prava Payments API
  description: >-
    Server-side REST API for Prava Payments. All requests are authenticated with
    your secret key (sk_test_* in sandbox, sk_live_* in production).
  version: 1.0.0
servers:
  - url: https://sandbox.api.prava.space
    description: Sandbox
  - url: https://api.prava.space
    description: Production
security:
  - bearerAuth: []
paths:
  /v1/webhook-event-types:
    get:
      tags:
        - Webhooks
      summary: GET /v1/webhook-event-types
      description: >-
        Gated preview; application and environment are derived from the secret
        key. See the Webhooks guide for delivery and signing contracts. Includes
        safe error examples and quote.request_failed request semantics; see
        /webhooks/errors. Retained payloads may lack additive error/stage
        fields.
      responses:
        '200':
          description: >-
            Successful operation; endpoints never include stored signing
            secrets.
          content:
            application/json:
              schema:
                type: object
                required:
                  - schema_version
                  - events
                properties:
                  schema_version:
                    type: string
                    examples:
                      - '2026-10-08'
                  events:
                    type: array
                    items:
                      $ref: '#/components/schemas/WebhookEventCatalogItem'
        '400':
          description: Invalid input or cursor
        '404':
          description: Resource not found in this application
        '409':
          description: Verification, idempotency, or endpoint state conflict
        '503':
          description: Preview disabled or temporarily unavailable
components:
  schemas:
    WebhookEventCatalogItem:
      type: object
      required:
        - type
        - description
        - supported_flows
        - schema
        - example
      properties:
        type:
          type: string
          enum:
            - payment.credentials_ready
            - payment.succeeded
            - payment.failed
            - card_enrollment.completed
            - card_enrollment.failed
            - card_enrollment.cancelled
            - card_enrollment.expired
            - mandate.created
            - mandate.creation_failed
            - mandate.creation_cancelled
            - mandate.creation_expired
            - mandate.paused
            - mandate.resumed
            - mandate.cancelled
            - mandate.expired
            - quote.request_failed
        description:
          type: string
        supported_flows:
          type: array
          items:
            type: string
        schema:
          type: object
          additionalProperties: true
          description: JSON Schema for this event envelope and its allowlisted data fields.
        example:
          type: object
          additionalProperties: true
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'Your secret key: sk_test_* (sandbox) or sk_live_* (production).'

````

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