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

# Send a test delivery

> Queues one example `trade_event.created` delivery to this endpoint only, signed like any other. It is held if the endpoint is paused or disabled.



## OpenAPI

````yaml /openapi-v2.json post /webhooks/{id}/test
openapi: 3.1.0
info:
  title: Centaur API
  version: 2.0.0
  description: >-
    Public API for reading Centaur's data over REST, with a companion MCP
    surface, and for partners to manage the webhook endpoints that receive
    Centaur events.
servers:
  - url: https://api.centaur.io/v2
    description: Centaur API v2
security: []
tags:
  - name: System
    description: Health and service metadata endpoints.
  - name: Discovery
    description: Read-only trader and asset directory discovery endpoints.
  - name: Events
    description: >-
      Historical trade-event reads with source, trader, asset, and position
      context.
  - name: Messages
    description: >-
      Read-only access to source messages by message timestamp or Source Message
      ID.
  - name: Channel Summaries
    description: Generated channel narrative summaries selected by Source Window overlap.
  - name: Aggregate Summaries
    description: >-
      Generated aggregate narrative summaries selected by Aggregate Window
      overlap.
  - name: Positions
    description: Read-only position history and open-position live state reads.
  - name: Stats
    description: Read-only aggregate trader and asset stats.
  - name: Webhooks
    description: >-
      Register HTTPS endpoints that receive signed event deliveries, manage
      their state and secrets, replay past deliveries and inspect delivery
      history. Requires the `webhooks.manage` permission on a partner account.
  - name: Widgets
    description: >-
      Hosted widget reads restricted to enabled registrations and approved
      origins.
externalDocs:
  description: Canonical Centaur API documentation
  url: https://docs.centaur.io
paths:
  /webhooks/{id}/test:
    post:
      tags:
        - Webhooks
      summary: Send a test delivery
      description: >-
        Queues one example `trade_event.created` delivery to this endpoint only,
        signed like any other. It is held if the endpoint is paused or disabled.
      operationId: sendWebhookTestDelivery
      parameters:
        - schema:
            type: string
            format: uuid
            description: Endpoint ID.
          required: true
          description: Endpoint ID.
          name: id
          in: path
      responses:
        '200':
          description: The queued test delivery
          content:
            application/json:
              example:
                success: true
                data:
                  eventId: 01a0efc4-3030-7c0b-97a6-d3611336958f
                  deliveryId: 1201
                  status: PENDING
                requestId: c8e2c6e4-80dd-4ffc-9d66-4e31bf64c6b8
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    enum:
                      - true
                  data:
                    $ref: '#/components/schemas/WebhookTestDelivery'
                  requestId:
                    type: string
                    example: c8e2c6e4-80dd-4ffc-9d66-4e31bf64c6b8
                required:
                  - success
                  - data
                  - requestId
        '401':
          description: Missing or invalid API key
          content:
            application/json:
              example:
                success: false
                error:
                  code: UNAUTHORIZED
                  message: Unauthorized
                requestId: c8e2c6e4-80dd-4ffc-9d66-4e31bf64c6b8
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '403':
          description: >-
            The API key lacks the `webhooks.manage` permission, or the account
            is not an active partner account (`PARTNER_REQUIRED`,
            `PARTNER_SUSPENDED`)
          content:
            application/json:
              example:
                success: false
                error:
                  code: FORBIDDEN
                  message: API key lacks webhooks.manage permission
                requestId: c8e2c6e4-80dd-4ffc-9d66-4e31bf64c6b8
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '404':
          description: No such endpoint on this account
          content:
            application/json:
              example:
                success: false
                error:
                  code: NOT_FOUND
                  message: Webhook endpoint not found
                requestId: c8e2c6e4-80dd-4ffc-9d66-4e31bf64c6b8
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '422':
          description: Request validation failed
          content:
            application/json:
              example:
                success: false
                error:
                  code: VALIDATION_ERROR
                  message: Request validation failed
                requestId: c8e2c6e4-80dd-4ffc-9d66-4e31bf64c6b8
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '503':
          description: Authentication service temporarily unavailable
          headers:
            Retry-After:
              description: Seconds to wait before retrying authentication
              schema:
                type: integer
                minimum: 1
          content:
            application/json:
              example:
                success: false
                error:
                  code: AUTHENTICATION_UNAVAILABLE
                  message: Authentication is temporarily unavailable
                requestId: c8e2c6e4-80dd-4ffc-9d66-4e31bf64c6b8
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
      security:
        - ApiKeyAuth: []
components:
  schemas:
    WebhookTestDelivery:
      type: object
      properties:
        eventId:
          type: string
          format: uuid
          description: ID of the test event. Its delivery carries this `id`.
        deliveryId:
          type: integer
          description: ID of the queued delivery, as listed under the endpoint deliveries.
        status:
          type: string
          enum:
            - PENDING
            - HELD
          description: >-
            `PENDING` when the endpoint is active and the delivery will be sent
            shortly; `HELD` when the endpoint is paused or disabled.
      required:
        - eventId
        - deliveryId
        - status
    ErrorEnvelope:
      type: object
      properties:
        success:
          type: boolean
          enum:
            - false
        error:
          $ref: '#/components/schemas/Error'
        requestId:
          type: string
          example: c8e2c6e4-80dd-4ffc-9d66-4e31bf64c6b8
      required:
        - success
        - error
        - requestId
    Error:
      type: object
      properties:
        code:
          type: string
          description: Stable machine-readable error code.
          example: UNAUTHORIZED
        message:
          type: string
          description: Human-readable explanation for the failure.
          example: Unauthorized
        details:
          description: Optional structured details for validation or input failures.
      required:
        - code
        - message
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: API key issued by Centaur.
      x-default: <api-key>

````

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