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

# List webhook events

> List logical events generated for the organization, including delivery summaries.



## OpenAPI

````yaml /api-reference/openapi.json get /v1/webhooks/events
openapi: 3.1.0
info:
  title: Kayle ID
  version: 1.5.0
  description: Privacy-first identity verification.
  license:
    name: Apache License 2.0
    url: https://github.com/kayleai/kayle-id/blob/main/LICENSE
  contact:
    name: Kayle ID
    url: https://kayle.id
    email: help@kayle.id
  termsOfService: https://kayle.id/terms
servers:
  - url: http://127.0.0.1:8787
    description: ''
security:
  - bearerAuth: []
paths:
  /v1/webhooks/events:
    get:
      tags:
        - Webhooks
      summary: List webhook events
      description: >-
        List logical events generated for the organization, including delivery
        summaries.
      parameters:
        - schema:
            type: string
            enum:
              - verification.session.succeeded
              - verification.session.failed
              - verification.session.expired
              - verification.session.cancelled
            description: Filter events by type (e.g. "verification.session.succeeded").
          required: false
          description: Filter events by type (e.g. "verification.session.succeeded").
          name: type
          in: query
        - schema:
            type: string
            format: date-time
            description: Return events created at or after this ISO 8601 timestamp.
          required: false
          description: Return events created at or after this ISO 8601 timestamp.
          name: created_from
          in: query
        - schema:
            type: string
            format: date-time
            description: Return events created at or before this ISO 8601 timestamp.
          required: false
          description: Return events created at or before this ISO 8601 timestamp.
          name: created_to
          in: query
        - schema:
            type: integer
            minimum: 1
            maximum: 100
            description: >-
              Maximum number of events to return. Defaults to 10 if not
              specified.
          required: false
          description: Maximum number of events to return. Defaults to 10 if not specified.
          name: limit
          in: query
        - schema:
            type: string
            minLength: 1
            maxLength: 128
            pattern: ^[A-Za-z0-9_-]+$
            description: >-
              Cursor of the last item from the previous page. When provided, the
              next page of results will be returned.
          required: false
          description: >-
            Cursor of the last item from the previous page. When provided, the
            next page of results will be returned.
          name: starting_after
          in: query
      responses:
        '200':
          description: Successful operation.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Webhook Event'
                  error:
                    type: 'null'
                  pagination:
                    $ref: '#/components/schemas/Pagination'
                required:
                  - data
                  - error
                  - pagination
        '500':
          description: Internal server error.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: 'null'
                    description: Empty data object.
                  error:
                    type:
                      - object
                      - 'null'
                    properties:
                      code:
                        type: string
                        description: The error code
                      message:
                        type: string
                        description: The error message
                      hint:
                        type: string
                        description: A hint to help the user fix the error
                      docs:
                        type: string
                        description: A link to the documentation for the error
                    required:
                      - code
                      - message
                      - hint
                      - docs
                  pagination:
                    type: object
                    properties:
                      limit:
                        type: number
                      has_more:
                        type: boolean
                        enum:
                          - false
                      next_cursor:
                        type: 'null'
                    required:
                      - limit
                      - has_more
                      - next_cursor
                required:
                  - data
                  - error
                  - pagination
      security:
        - bearerAuth: []
components:
  schemas:
    Webhook Event:
      type: object
      properties:
        id:
          type: string
          description: Event ID
        type:
          type: string
          description: The type of the event (e.g. "verification.session.succeeded").
        trigger_type:
          type: string
          enum:
            - verification_session
            - verification_attempt
          description: The type of object that triggered this event.
        trigger_id:
          type: string
          description: >-
            The ID of the object that triggered this event (e.g. a verification
            session or attempt ID).
        created_at:
          type: string
          description: The time the event was created.
        deliveries:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
                description: Webhook delivery ID
              webhook_endpoint_id:
                type: string
                description: The ID of the webhook endpoint this delivery targets
              status:
                type: string
                enum:
                  - pending
                  - delivering
                  - succeeded
                  - failed
                description: The status of the webhook delivery
              last_status_code:
                type:
                  - number
                  - 'null'
                description: The last HTTP status code received from the endpoint, if any.
              attempt_count:
                type: number
                description: The number of attempts made to deliver the webhook
              last_attempt_at:
                type:
                  - string
                  - 'null'
                description: The time the last delivery attempt was made, if any.
              payload_expires_at:
                type:
                  - string
                  - 'null'
                description: When the encrypted payload expires for manual retry/replay.
              payload_scrubbed_at:
                type:
                  - string
                  - 'null'
                description: When the encrypted payload was scrubbed, if no longer stored.
              payload_retention_reason:
                type:
                  - string
                  - 'null'
                enum:
                  - pending_delivery
                  - delivered
                  - terminal_failure_retention
                  - expired
                  - no_active_key
                  - jwe_creation_failed
                  - privacy_request
                description: Why the payload is retained or why it was scrubbed.
            required:
              - id
              - webhook_endpoint_id
              - status
              - last_status_code
              - attempt_count
              - last_attempt_at
              - payload_expires_at
              - payload_scrubbed_at
              - payload_retention_reason
          description: Deliveries associated with this event.
      required:
        - id
        - type
        - trigger_type
        - trigger_id
        - created_at
        - deliveries
    Pagination:
      type: object
      properties:
        limit:
          type: number
          description: The maximum number of items returned.
          example: 10
        has_more:
          type: boolean
          description: Whether there are more items available after this page.
          example: false
        next_cursor:
          type:
            - string
            - 'null'
          description: >-
            Cursor to use as `starting_after` to fetch the next page of results,
            or null if there are no more items.
          example: null
      required:
        - limit
        - has_more
        - next_cursor
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

````