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

# Create a webhook endpoint

> Create a webhook endpoint. Name one destination: `url` for `destination_kind: http`, `sqs` for `destination_kind: sqs`. Naming the other kind's field is a 400 that says which field does not belong, rather than a 201 that saved half the body. `destination_kind` may be omitted and then means `http`. The signing secret is returned ONCE in this response and never again; roll it to get a new one. Send `Idempotency-Key` to make a retry safe: a replay returns the original response including its `secret`, which is the only way to recover a secret whose response was lost in transit.



## OpenAPI

````yaml POST /api/webhooks/v1/endpoints
openapi: 3.1.0
info:
  title: LangWatch API
  version: 1.0.0
  description: LangWatch openapi spec
servers:
  - url: https://app.langwatch.ai
security:
  - project_api_key: []
paths:
  /api/webhooks/v1/endpoints:
    post:
      tags:
        - Webhooks
      summary: Create a webhook endpoint
      description: >-
        Create a webhook endpoint. Name one destination: `url` for
        `destination_kind: http`, `sqs` for `destination_kind: sqs`. Naming the
        other kind's field is a 400 that says which field does not belong,
        rather than a 201 that saved half the body. `destination_kind` may be
        omitted and then means `http`. The signing secret is returned ONCE in
        this response and never again; roll it to get a new one. Send
        `Idempotency-Key` to make a retry safe: a replay returns the original
        response including its `secret`, which is the only way to recover a
        secret whose response was lost in transit.
      operationId: postApiWebhooksV1Endpoints
      parameters:
        - name: Idempotency-Key
          in: header
          required: false
          description: >-
            A caller-chosen key, 8 to 255 characters, that makes this create
            safe to retry. The first request to use a key runs normally and its
            response is stored for 24 hours. A later request with the same key
            and the same body is not executed again: it returns the stored
            response, marked with `X-Idempotent-Replay: true`. The same key with
            a different body is refused 409 `idempotency_error`, as is a retry
            sent while the original is still running. Only successful responses
            are stored, so a create that failed can simply be retried with the
            same key.
          schema:
            type: string
            minLength: 8
            maxLength: 255
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                destination_kind:
                  type: string
                  enum:
                    - http
                    - sqs
                url:
                  type: string
                  minLength: 1
                  maxLength: 2000
                sqs:
                  type: object
                  properties:
                    queue_url:
                      type: string
                      minLength: 1
                      maxLength: 2000
                    role_arn:
                      type: string
                      minLength: 1
                      maxLength: 2048
                    external_id:
                      type: string
                      minLength: 1
                      maxLength: 1224
                    access_key_id:
                      type: string
                      minLength: 1
                      maxLength: 128
                    secret_access_key:
                      type: string
                      minLength: 1
                      maxLength: 256
                  required:
                    - queue_url
                enabled_events:
                  type: array
                  items:
                    type: string
                    minLength: 1
                    maxLength: 200
                  minItems: 1
                  maxItems: 100
                max_batch_size:
                  type: integer
                max_batch_delay_ms:
                  type: integer
                max_in_flight:
                  type: integer
              required:
                - enabled_events
      responses:
        '201':
          description: The endpoint, with the signing secret this body alone carries
          headers:
            X-Idempotent-Replay:
              description: >-
                Present and `true` only when this body came from a stored
                response rather than a fresh execution. Absent on the first use
                of a key, and on every request that carries no key.
              schema:
                type: string
                enum:
                  - 'true'
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    oneOf:
                      - type: object
                        properties:
                          destination_kind:
                            type: string
                            const: http
                          url:
                            type: string
                          sqs:
                            type: 'null'
                          id:
                            type: string
                          enabled_events:
                            type: array
                            items:
                              type: string
                          status:
                            type: string
                            enum:
                              - active
                              - disabled
                          disabled_reason:
                            type:
                              - string
                              - 'null'
                          disabled_at:
                            type:
                              - string
                              - 'null'
                          failing_since:
                            type:
                              - string
                              - 'null'
                          last_success_at:
                            type:
                              - string
                              - 'null'
                          last_failure_at:
                            type:
                              - string
                              - 'null'
                          max_batch_size:
                            type: integer
                          max_batch_delay_ms:
                            type: integer
                          max_in_flight:
                            type: integer
                          created_at:
                            type: string
                          updated_at:
                            type: string
                          secret:
                            type: string
                        required:
                          - destination_kind
                          - url
                          - sqs
                          - id
                          - enabled_events
                          - status
                          - disabled_reason
                          - disabled_at
                          - failing_since
                          - last_success_at
                          - last_failure_at
                          - max_batch_size
                          - max_batch_delay_ms
                          - max_in_flight
                          - created_at
                          - updated_at
                          - secret
                      - type: object
                        properties:
                          destination_kind:
                            type: string
                            const: sqs
                          url:
                            type: 'null'
                          sqs:
                            type: object
                            properties:
                              queue_url:
                                type: string
                              region:
                                type: string
                              account_id:
                                type: string
                              queue_name:
                                type: string
                              credential_mode:
                                type: string
                                enum:
                                  - assume_role
                                  - static
                                  - ambient
                              role_arn:
                                type:
                                  - string
                                  - 'null'
                              external_id:
                                type:
                                  - string
                                  - 'null'
                              access_key_id:
                                type:
                                  - string
                                  - 'null'
                            required:
                              - queue_url
                              - region
                              - account_id
                              - queue_name
                              - credential_mode
                              - role_arn
                              - external_id
                              - access_key_id
                          id:
                            type: string
                          enabled_events:
                            type: array
                            items:
                              type: string
                          status:
                            type: string
                            enum:
                              - active
                              - disabled
                          disabled_reason:
                            type:
                              - string
                              - 'null'
                          disabled_at:
                            type:
                              - string
                              - 'null'
                          failing_since:
                            type:
                              - string
                              - 'null'
                          last_success_at:
                            type:
                              - string
                              - 'null'
                          last_failure_at:
                            type:
                              - string
                              - 'null'
                          max_batch_size:
                            type: integer
                          max_batch_delay_ms:
                            type: integer
                          max_in_flight:
                            type: integer
                          created_at:
                            type: string
                          updated_at:
                            type: string
                          secret:
                            type: string
                        required:
                          - destination_kind
                          - url
                          - sqs
                          - id
                          - enabled_events
                          - status
                          - disabled_reason
                          - disabled_at
                          - failing_since
                          - last_success_at
                          - last_failure_at
                          - max_batch_size
                          - max_batch_delay_ms
                          - max_in_flight
                          - created_at
                          - updated_at
                          - secret
                required:
                  - data
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      type:
                        type: string
                      code:
                        type: string
                      message:
                        type: string
                      meta:
                        type: object
                        additionalProperties: {}
                      trace_id:
                        type: string
                      span_id:
                        type: string
                    required:
                      - type
                      - code
                      - message
                required:
                  - error
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      type:
                        type: string
                      code:
                        type: string
                      message:
                        type: string
                      meta:
                        type: object
                        additionalProperties: {}
                      trace_id:
                        type: string
                      span_id:
                        type: string
                    required:
                      - type
                      - code
                      - message
                required:
                  - error
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      type:
                        type: string
                      code:
                        type: string
                      message:
                        type: string
                      meta:
                        type: object
                        additionalProperties: {}
                      trace_id:
                        type: string
                      span_id:
                        type: string
                    required:
                      - type
                      - code
                      - message
                required:
                  - error
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      type:
                        type: string
                      code:
                        type: string
                      message:
                        type: string
                      meta:
                        type: object
                        additionalProperties: {}
                      trace_id:
                        type: string
                      span_id:
                        type: string
                    required:
                      - type
                      - code
                      - message
                required:
                  - error
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      type:
                        type: string
                      code:
                        type: string
                      message:
                        type: string
                      meta:
                        type: object
                        additionalProperties: {}
                      trace_id:
                        type: string
                      span_id:
                        type: string
                    required:
                      - type
                      - code
                      - message
                required:
                  - error
      security:
        - admin_api_key: []
components:
  securitySchemes:
    project_api_key:
      type: apiKey
      in: header
      name: X-Auth-Token
      description: >-
        Project API key for sending traces and accessing project-scoped
        resources. Format: sk-lw-... (no underscore). Obtain one by creating a
        project via the Admin API or the LangWatch UI.
    admin_api_key:
      type: http
      scheme: bearer
      description: >-
        Admin API key for organization-level operations (managing projects, API
        keys). Create one in Settings > API Keys or via POST /api/api-keys.
        Format: sk-lw-{id}_{secret}.

````