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

# Get webhook events

> Returns the catalog of available webhook event types and their descriptions.



## OpenAPI

````yaml GET /v2/webhooks/events
openapi: 3.0.3
info:
  title: Samora AI API
  description: >
    The Samora AI API lets you trigger immediate outbound calls and manage
    outbound campaigns through the Samora AI system. Use it to start calls with
    your AI agents, pass per-call context, create campaigns, add recipients, and
    manage campaign lifecycle from your server.


    **Authentication:** Every request must include your organization API key in
    the `X-API-Key` header. These APIs are intended for server-to-server
    integrations; do not expose your organization API key in browser or mobile
    clients.


    **Phone number format:** Destination numbers must be in E.164 format (e.g.
    `+919876543210`) and include the country code. The pattern is: `+` followed
    by 10-15 digits.


    **Call statuses:** When you fetch call details, `status` can be: `PENDING`,
    `TRIGGERED`, `ONGOING`, `CALL_FINISHED`, `UNANSWERED`, `REJECTED`.


    **Campaign statuses:** Campaign `status` can be: `DRAFT`, `SCHEDULED`,
    `IN_PROGRESS`, `PAUSED`, `FINISHED`, `FAILED`, `CANCELLED`.


    **Campaign lifecycle:** Recipients can be added only while a campaign is
    `DRAFT` or `PAUSED`. Campaigns can be started only from `DRAFT` or `PAUSED`,
    stopped only from `IN_PROGRESS`, and cancelled unless they are already
    `FINISHED`, `FAILED`, or `CANCELLED`.


    **Campaign API limits:** Request bodies are limited to 2 MiB. Campaign names
    can be up to 120 characters. List requests support `page_size` up to 100.
    Add recipients accepts up to 5000 phone numbers per request, and each
    recipient's `call_variables` can be up to 4 KiB.


    **Transcripts and recordings:** For finished calls, presigned URLs for
    transcript and recording are valid for 60 minutes.
  version: 1.0.0
  license:
    name: Proprietary
servers:
  - url: https://api.samora.ai
    description: Production server
security:
  - ApiKeyAuth: []
paths:
  /v2/webhooks/events:
    get:
      description: >-
        Returns the catalog of available webhook event types and their
        descriptions.
      responses:
        '200':
          description: Events catalog retrieved successfully
          content:
            application/json:
              schema:
                type: object
                required:
                  - data
                properties:
                  data:
                    $ref: '#/components/schemas/EventsCatalogResponse'
                additionalProperties: false
              examples:
                success:
                  value:
                    data:
                      events:
                        - event_type: CALL_STARTED
                          display_name: Call Started
                          description: >-
                            Triggered when a call begins (inbound or outbound).
                            Basic call info available.
                          available_data_options: []
                        - event_type: CALL_FINISHED
                          display_name: Call Finished
                          description: >-
                            Triggered when a call ends with transcript and
                            recording available.
                          available_data_options:
                            - include_transcript
                            - include_recording_url
                        - event_type: CALL_FAILED
                          display_name: Call Failed
                          description: >-
                            Triggered when a call fails, is rejected, or goes
                            unanswered.
                          available_data_options: []
components:
  schemas:
    EventsCatalogResponse:
      type: object
      required:
        - events
      properties:
        events:
          type: array
          items:
            $ref: '#/components/schemas/EventCatalog'
      additionalProperties: false
    EventCatalog:
      type: object
      required:
        - event_type
        - display_name
        - description
        - available_data_options
      properties:
        event_type:
          type: string
          description: The event type identifier.
        display_name:
          type: string
          description: Human-readable name.
        description:
          type: string
          description: Description of when this event fires.
        available_data_options:
          type: array
          items:
            type: string
          description: Data options available for this event type.
      additionalProperties: false
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: Your unique organization API key. Required on all requests.

````