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

# Send Test Event

> Deliver a signed system.test event to the webhook's endpoint immediately, without waiting for a real signal, and record it as a delivery. The request body is ignored. Returns the delivery outcome. Free (0 credits).



## OpenAPI

````yaml POST /webhooks/{id}/test
openapi: 3.1.0
info:
  title: Webhooks API
  description: >-
    Manage webhook subscriptions as a first-class API resource. Create, list,
    retrieve, update, rotate the signing secret of, test, and delete webhooks;
    list delivery attempts and manually retry failed deliveries. The dashboard
    Webhooks UI calls these exact endpoints — there is no separate code path.
  license:
    name: MIT
  version: 2.0.0
servers:
  - url: https://www.trysignalbase.com/api/v2
security:
  - bearerAuth: []
paths:
  /webhooks/{id}/test:
    post:
      summary: Send Test Event
      description: >-
        Deliver a signed system.test event to the webhook's endpoint
        immediately, without waiting for a real signal, and record it as a
        delivery. The request body is ignored. Returns the delivery outcome.
        Free (0 credits).
      operationId: testWebhook
      parameters:
        - $ref: '#/components/parameters/WebhookId'
      responses:
        '200':
          description: The test event was sent and recorded as a delivery.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WebhookTestResponse'
              example:
                success: true
                data:
                  success: true
                  delivery_id: 9c8b7a65-4d3e-4f21-8a0b-1c2d3e4f5a60
                  event_id: 1f2e3d4c-5b6a-4790-8a1b-2c3d4e5f6071
                  event_type: system.test
                  response_status: 200
                  response_body: ok
                meta:
                  endpoint: webhooks.test
                  creditsUsed: 0
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/SubscriptionExpired'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/InternalError'
components:
  parameters:
    WebhookId:
      name: id
      in: path
      required: true
      description: The webhook subscription ID.
      schema:
        type: string
  schemas:
    WebhookTestResponse:
      type: object
      required:
        - success
        - data
        - meta
      properties:
        success:
          type: boolean
          const: true
        data:
          type: object
          required:
            - success
            - delivery_id
            - event_id
            - event_type
            - response_status
            - response_body
          properties:
            success:
              type: boolean
              description: Whether the endpoint accepted the test event with a 2xx.
            delivery_id:
              type: string
            event_id:
              type: string
            event_type:
              type: string
              const: system.test
            response_status:
              type: integer
            response_body:
              type: string
        meta:
          $ref: '#/components/schemas/ResponseMeta'
    ResponseMeta:
      type: object
      required:
        - endpoint
        - creditsUsed
      properties:
        endpoint:
          type: string
          description: Endpoint identifier (e.g. webhooks.create).
        creditsUsed:
          type: integer
          minimum: 0
          description: API credits consumed by this request.
    ErrorResponse:
      type: object
      required:
        - success
        - error
        - code
      properties:
        success:
          type: boolean
          const: false
        error:
          type: string
          description: Human-readable error message.
        code:
          type: string
          enum:
            - bad_request
            - invalid_api_key
            - subscription_expired
            - not_found
            - conflict
            - rate_limited
            - internal_server_error
            - internal_error
        retryAfter:
          type: integer
          description: >-
            Seconds until a retry is recommended. Present on rate-limit (429)
            responses.
  responses:
    Unauthorized:
      description: Missing or invalid API key.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            success: false
            error: Invalid API key. No key found.
            code: invalid_api_key
    SubscriptionExpired:
      description: The API key belongs to a team without an active subscription.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            success: false
            error: >-
              Subscription expired. Please upgrade your subscription:
              https://www.trysignalbase.com/#pricing
            code: subscription_expired
    NotFound:
      description: No webhook (or delivery) with that ID exists for the authenticated team.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            success: false
            error: Webhook not found
            code: not_found
    RateLimited:
      description: >-
        Rate limit exceeded for this team and endpoint. The response also sets
        X-RateLimit-Limit, X-RateLimit-Remaining, and X-RateLimit-Reset headers.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            success: false
            error: Too many requests. Please upgrade your plan or slow down.
            code: rate_limited
            retryAfter: 60
    InternalError:
      description: Unexpected server error.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            success: false
            error: An unknown error occurred
            code: internal_error
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API key
      description: >-
        Signalbase API key. Include as a Bearer token in the Authorization
        header.

````