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

# Test webhook endpoint

> Send a test event to a webhook endpoint to verify connectivity.
Check your server logs to confirm the signed payload arrived.



## OpenAPI

````yaml /openapi.yml post /webhooks/endpoint/test
openapi: 3.1.0
info:
  title: Cargado API
  version: 1.0.0
  description: Cargado's API
  termsOfService: https://cargado.com/terms/
  contact:
    email: dev-support@cargado.com
servers:
  - url: https://api.cargado.com
    description: The production Cargado API server
security: []
tags:
  - name: Border Crossings
  - name: Loads
  - name: Rates
  - name: CarrierRelationship
  - name: User
  - name: Team
  - name: Webhooks
  - name: Bids
paths:
  /webhooks/endpoint/test:
    post:
      tags:
        - Webhooks
      summary: Test webhook endpoint
      description: |-
        Send a test event to a webhook endpoint to verify connectivity.
        Check your server logs to confirm the signed payload arrived.
      operationId: TestEndpoint
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TestWebhookEndpointBody'
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                properties:
                  timestamp:
                    type: string
                  eventType:
                    type: string
                  messageId:
                    type: string
                required:
                  - timestamp
                  - eventType
                  - messageId
                type: object
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                properties:
                  message:
                    type: string
                required:
                  - message
                type: object
      security:
        - apiKey: []
components:
  schemas:
    TestWebhookEndpointBody:
      properties:
        endpointId:
          type: string
          description: ID of the endpoint to send a test event to
          minLength: 1
          maxLength: 256
        eventType:
          $ref: '#/components/schemas/WebhookEventType'
          description: Event type to simulate. Defaults to `bid.accepted`.
          examples:
            - bid.created
      required:
        - endpointId
      type: object
      additionalProperties: true
    WebhookEventType:
      type: string
      enum:
        - bid.created
        - bid.accepted
        - bid.rejected
        - bid.revoked
        - bid.closed
        - bid.countered
        - bid.counter_accepted
        - bid.counter_revoked
        - bid.counter_rejected
      description: |-
        Event types available for webhook subscriptions.
        Use these values in `filterTypes` to receive only specific events.
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: api-key

````