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

# Get webhook config

> Read the org's current webhook config. The `secret` is masked —
the full value is only ever shown at create / rotate time.



## OpenAPI

````yaml https://api.staging.xtrace.ai/openapi.public.json get /v1/webhooks
openapi: 3.1.0
info:
  title: XTrace Vec DB
  description: XTrace API
  version: 1.0.0
servers:
  - url: https://api.production.xtrace.ai
    description: Production
security:
  - ApiKeyHeader: []
  - BearerToken: []
paths:
  /v1/webhooks:
    get:
      tags:
        - webhooks
      summary: Get webhook config
      description: |-
        Read the org's current webhook config. The `secret` is masked —
        the full value is only ever shown at create / rotate time.
      operationId: get_webhook_v1_webhooks_get
      parameters:
        - name: org_id
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: Org Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WebhookConfig'
        '404':
          description: '`detail.code = "webhook_not_found"` — no config set for this org.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      x-codeSamples:
        - lang: typescript
          label: TypeScript SDK
          source: |
            import { MemoryClient } from '@xtraceai/memory';

            const client = new MemoryClient({
              apiKey: process.env.XTRACE_API_KEY!,
              orgId:  process.env.XTRACE_ORG_ID!,
            });

            const wh = await client.webhooks.get(); // secret comes back masked
            console.log(wh.url, wh.events, wh.enabled);
components:
  schemas:
    WebhookConfig:
      properties:
        object:
          type: string
          const: webhook
          title: Object
          description: Constant discriminator for the resource type.
          default: webhook
        url:
          type: string
          title: Url
          description: Configured subscriber URL.
        events:
          items:
            type: string
            enum:
              - memory.learning.completed
              - memory.learning.failed
          type: array
          title: Events
          description: Event types currently subscribed.
        enabled:
          type: boolean
          title: Enabled
          description: Whether deliveries are active.
        secret:
          type: string
          title: Secret
          description: >-
            Signing secret used to verify `X-Webhook-Signature`. Returned in
            **full only when freshly minted** — a first `PUT` (create) or
            `PUT?rotate_secret=true`. Store it then; every other response (a
            plain edit, or `GET`) masks it.
        created_at:
          type: string
          format: date-time
          title: Created At
          description: ISO-8601 timestamp the config was first created.
        updated_at:
          anyOf:
            - type: string
            - type: 'null'
          format: date-time
          title: Updated At
          description: ISO-8601 timestamp of the most recent edit.
      type: object
      required:
        - url
        - events
        - enabled
        - secret
        - created_at
      title: WebhookConfig
      description: Wire shape of the org's webhook config.
    ErrorEnvelope:
      properties:
        detail:
          $ref: '#/components/schemas/ErrorDetail'
      type: object
      required:
        - detail
      title: ErrorEnvelope
      description: |-
        Standard error body for non-2xx responses raised by the memory
        API. Pydantic field-validation failures (422) use the FastAPI-
        default ``HTTPValidationError`` shape instead, where ``detail`` is
        an array of per-field error entries — switch on the response
        status code to pick the right shape.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ErrorDetail:
      properties:
        code:
          type: string
          title: Code
          description: >-
            Stable error identifier. Switch on this rather than parsing the
            message. Common values: `invalid_request`, `invalid_messages`,
            `memory_not_found`, `job_not_found`, `immutable_field`,
            `reserved_field`, `empty_text_field`, `missing_user_id`,
            `missing_conv_id`, `unsupported_include_option`, `cursor_mismatch`,
            `unauthorized`, `forbidden`, `rate_limited`, `delete_failed`,
            `search_failed`, `ingest_failed`, `server_error`.
          examples:
            - memory_not_found
        message:
          type: string
          title: Message
          description: Human-readable summary; safe to log but not safe to switch on.
          examples:
            - Memory 0fa1c0e6-... not found
      type: object
      required:
        - code
        - message
      title: ErrorDetail
      description: |-
        Inner ``detail`` block on every non-2xx response raised by a
        memory-API route handler. ``code`` is the stable identifier
        clients should switch on; ``message`` is a sanitized human-
        readable summary.
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    ApiKeyHeader:
      type: apiKey
      in: header
      name: x-api-key
      description: 'Long-lived org API key. Alternative: `Authorization: Bearer <key>`.'
    BearerToken:
      type: http
      scheme: bearer
      bearerFormat: Token
      description: 'Long-lived API key sent as `Authorization: Bearer <api-key>`.'

````