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

# Query webhooks

> **Deprecated.** Returns webhooks matching legacy query filters. Use `GET /v2/webhooks` for pagination, search, event filtering, and sorting.



## OpenAPI

````yaml post /v2/webhooks/query
openapi: 3.1.0
info:
  title: orq.ai API
  version: '2.0'
  description: orq.ai API documentation
servers:
  - url: https://my.orq.ai
security:
  - ApiKey: []
tags:
  - name: Chunking
    description: Split text into smaller chunks for retrieval and generation workflows.
  - name: File Systems
    description: >-
      Create and manage persistent file systems that agents and MCP clients read
      from and write to.
  - name: Knowledge Bases
    description: Create and manage knowledge bases used by agents and retrieval workflows.
  - name: Memory Stores
    description: Create and manage memory stores, memories, and memory documents.
  - name: Evals
    description: Run an evaluator against a conversation and its result
  - name: Logs
    description: >-
      OpenTelemetry log query API. Search, filter, aggregate, and facet log
      records ingested via OTLP.
  - name: Reporting
    description: >-
      GenAI reporting API over canonical analytics rollups. Accepts a metric
      name, time range, grain, group-by, and filters; returns a typed time
      series and optional totals.
  - name: Traces
    description: >-
      Query and inspect ingested trace data: search trace summaries, aggregate
      metrics, and read individual traces and their spans.
  - description: List models available through the AI Router.
    name: Models
  - name: Policies
  - name: Alerts
    description: >-
      Alerts evaluate a Reporting API metric on a fixed interval and fire
      notifications through notifiers when the value breaches a threshold. Each
      breach opens a trigger that tracks the incident until the value recovers.
  - name: Annotation Queues
    description: Annotation queues collect spans for human review.
  - name: API keys
    description: >-
      API keys authenticate programmatic access to the workspace. They expose
      opaque tokens, per-domain access grants, and budget and rate-limit
      constraints.
  - name: Audit Logs
    description: Audit logs record workspace entity changes and access-relevant events.
  - name: Budgets
    description: >-
      Budgets govern spend, token usage, and request rate across six scopes:
      workspace, project, identity, API key, provider, and model. Every
      applicable budget is enforced, and the most restrictive limit applies per
      dimension.
  - name: Files
    description: File upload and retrieval operations.
  - name: Guardrail Rules
    description: >-
      Guardrail Rules conditionally enforce evaluators and plugins for AI
      Gateway traffic. Rules may be scoped to a project or the whole workspace.
  - name: Hub
    description: Hub items are reusable templates available to a workspace.
  - name: Identities
    description: >-
      Identities represent end users from your system for usage and engagement
      tracking.
  - name: Management keys
    description: >-
      Management keys are workspace-scoped credentials that authenticate
      programmatic access to workspace administration surfaces (API keys,
      budgets). Unlike project-scoped API keys, a management key always operates
      at the workspace level.
  - name: MCP Gateway
    description: >-
      Register upstream MCP servers, discover and sync their tools, and assemble
      gateways that expose a curated tool surface to MCP clients.
  - name: Model Catalog
    description: >-
      Browse the orq.ai model catalog: every model orq offers, across every
      provider, with pricing, capabilities and benchmark data. List endpoints
      only return models that are not deprecated. This API is public, requires
      no authentication, and is rate limited to 120 requests per minute per IP.
      Responses carry a 5-minute cache-control max-age.
  - name: Notifiers
    description: Notifier destinations used to send delivery and workflow notifications.
  - name: Projects
    description: Projects organize resources within a workspace
  - name: Routing Rules
    description: >-
      Routing Rules conditionally select models and enforce request plugins for
      AI Gateway traffic. Rules are evaluated by ascending priority and may be
      scoped to a project or the whole workspace.
  - name: Threads
    description: Threads group related trace invocations and their aggregate usage
  - name: Skills
    description: >-
      Skills are modular instructions you can use to codify processes and
      conventions
  - name: Smart Routers
    description: >-
      Create and manage workspace Smart Routers. A Smart Router selects a model
      from an eligible pool for each request according to a quality, balanced,
      or cost profile.
  - name: Webhooks
    description: >-
      Create and manage webhooks that deliver workspace events to external HTTPS
      endpoints.
  - name: Workspaces
    description: >-
      A workspace is the tenant. Create is a user-session onboarding RPC; Get,
      List, and Update are the public management surface.
  - name: Workspace Security
    description: >-
      Workspace-level domain verification and IP allowlist controls. These
      operations are restricted to workspace administrators.
  - name: Workspace Settings
    description: >-
      Workspace-level settings managed with a workspace credential. A workspace
      is the tenant, so these settings are a singleton — there is nothing to
      create or delete, only read and update.
  - name: Responses
  - description: Run agents on a cron cadence. Minimum firing interval is 1 hour.
    name: Agent Schedules
  - name: Embeddings
  - name: Telemetry
    description: >-
      Unified query envelope for traces, metrics, and logs (ADR 0004). One
      request shape, one filter dialect, and one response shape per source,
      validated by a per-source registry.
externalDocs:
  url: https://docs.orq.ai
  description: orq.ai Documentation
paths:
  /v2/webhooks/query:
    post:
      tags:
        - Webhooks
      summary: Query webhooks
      description: >-
        **Deprecated.** Returns webhooks matching legacy query filters. Use `GET
        /v2/webhooks` for pagination, search, event filtering, and sorting.
      operationId: WebhookQuery
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/QueryWebhooksRequest'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueryWebhooksResponse'
      deprecated: true
      x-code-samples:
        - lang: curl
          label: Core - Query webhooks
          source: |
            curl --request POST \
              --url 'https://my.orq.ai/v2/webhooks/query' \
              --header "Authorization: Bearer $ORQ_API_KEY" \
              --header 'Content-Type: application/json' \
              --data '{
                "sortingProps": [{"key": "created", "direction": "desc"}],
                "filters": []
              }'
components:
  schemas:
    QueryWebhooksRequest:
      type: object
      properties:
        pagination:
          $ref: '#/components/schemas/QueryParamsPagination'
        sortingProps:
          type: array
          items:
            $ref: '#/components/schemas/QueryParamsSort'
        query:
          type: object
        filters:
          type: array
          items:
            type: object
        includedFields:
          type: object
          additionalProperties:
            type: string
    QueryWebhooksResponse:
      required:
        - count
        - items
      type: object
      properties:
        count:
          type: integer
          format: int32
        items:
          type: array
          items:
            $ref: '#/components/schemas/Webhook'
    QueryParamsPagination:
      type: object
      properties:
        page:
          type: integer
          format: int32
        limit:
          type: integer
          format: int32
        lastId:
          type: string
        firstId:
          type: string
    QueryParamsSort:
      type: object
      properties:
        key:
          type: string
        direction:
          type: string
    Webhook:
      required:
        - _id
        - url
        - content_type
        - display_name
        - events
        - secret
        - created_by_id
        - updated_by_id
        - created
        - updated
      type: object
      properties:
        _id:
          type: string
          description: Unique webhook ID.
        url:
          pattern: ^https://
          type: string
          description: HTTPS endpoint that receives webhook deliveries.
          format: uri
        content_type:
          enum:
            - application/json
            - application/x-www-form-urlencoded
          type: string
          description: Content type sent with webhook deliveries.
        display_name:
          type: string
          description: Human-readable webhook name.
        events:
          type: array
          items:
            type: string
          description: >-
            Workspace event slugs that trigger a delivery, for example
            `deployment.invoked` or `llm.response`.
        secret:
          type: string
          description: >-
            Signing secret used to compute `X-Orq-Signature` as the lowercase
            hexadecimal HMAC-SHA256 of the exact request body bytes. Shown in
            full only in the create response; list and get return a masked
            value.
        enabled:
          type: boolean
          description: Whether webhook deliveries are enabled.
        failure_count:
          readOnly: true
          type: integer
          description: Server-managed number of consecutive delivery failures.
          format: int32
        created_by_id:
          readOnly: true
          type: string
          description: Account ID that created the webhook.
        updated_by_id:
          readOnly: true
          type: string
          description: Account ID that most recently updated the webhook.
        created:
          readOnly: true
          type: string
          description: Creation time in RFC 3339 format.
          format: date-time
        updated:
          readOnly: true
          type: string
          description: Most recent update time in RFC 3339 format.
          format: date-time
      description: >-
        A webhook subscription and its delivery configuration. The signing
        secret is shown in full only in the create response and is masked
        everywhere else.
  securitySchemes:
    ApiKey:
      type: http
      scheme: bearer
      bearerFormat: JWT

````