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

# Test Webhook Endpoint

> Enqueue a synthetic test event to the given endpoint.

Bypasses the endpoint's event-filter list so the "Test" button reliably
delivers regardless of which events the endpoint normally subscribes to.



## OpenAPI

````yaml /openapi.json post /v1/webhook-endpoints/{endpoint_id}/test
openapi: 3.1.0
info:
  title: Ontora API
  description: >-
    Ontora's public API. Covers interview campaigns, contacts, transcripts,
    question results, synthesis reports, graph queries, exports, and outbound
    webhooks. 


    **Authentication**: most endpoints accept either a Clerk JWT
    (`Authorization: Bearer <token>`) or a workspace API key (`X-API-Key:
    ont_...`). Create keys in the dashboard under **Developer → API Keys**. 


    This reference is the supported public surface. Paths not listed here are
    internal and may change without notice.
  version: 0.1.0
servers: []
security:
  - ClerkJWT: []
  - WorkspaceApiKey: []
tags:
  - name: interviews
    description: Campaign CRUD, lifecycle, contacts, question sets.
  - name: campaign-insights
    description: Campaign conversations and recording downloads.
  - name: campaign-reports
    description: Synthesis Reports — regenerate, generation status, current version.
  - name: question-results
    description: Results for structured campaign questions.
  - name: interview-query
    description: Graph RAG query over campaign data.
  - name: insights-chat
    description: Durable full-corpus analysis runs.
  - name: interview-export
    description: Markdown / ZIP / PDF exports of transcripts, responses, and reports.
  - name: protected-corpus
    description: Hash-verified raw-corpus access for Confidential analysis keys.
  - name: people
    description: Workspace people directory that feeds campaign contacts.
  - name: webhook-endpoints
    description: Outbound webhook endpoints for automation.
paths:
  /v1/webhook-endpoints/{endpoint_id}/test:
    post:
      tags:
        - webhook-endpoints
      summary: Test Webhook Endpoint
      description: |-
        Enqueue a synthetic test event to the given endpoint.

        Bypasses the endpoint's event-filter list so the "Test" button reliably
        delivers regardless of which events the endpoint normally subscribes to.
      operationId: test_webhook_endpoint_v1_webhook_endpoints__endpoint_id__test_post
      parameters:
        - name: endpoint_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
            title: Endpoint Id
        - name: X-API-Key
          in: header
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: X-Api-Key
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: >-
                  Response Test Webhook Endpoint V1 Webhook Endpoints  Endpoint
                  Id  Test Post
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - HTTPBearer: []
components:
  schemas:
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    ClerkJWT:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Clerk-issued RS256 JWT.
    WorkspaceApiKey:
      type: apiKey
      in: header
      name: X-API-Key
      description: 'Workspace-scoped API key (prefix: `ont_`).'
    HTTPBearer:
      type: http
      scheme: bearer

````

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