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

# Send a test.ping delivery to a workspace webhook



## OpenAPI

````yaml /openapi/developer-api.json post /api/developer/workspaces/{workspaceId}/webhooks/{endpointId}/test
openapi: 3.1.0
info:
  title: CollabOS Developer API
  version: 1.0.0
  description: >-
    Formal contract for CollabOS API-key data-plane endpoints, authenticated
    developer-management endpoints, and webhook delivery payloads. API-key
    cursors are opaque and must not be constructed by clients.
servers:
  - url: https://api.collabos.app
    description: Production
security: []
tags:
  - name: Personal API
    description: Personal API-key data-plane endpoints.
  - name: Workspace API
    description: Workspace API-key data-plane endpoints.
  - name: Entries
    description: Native raffle entry operations for personal API keys.
  - name: Developer Management
    description: JWT-authenticated developer capabilities and API-key management.
  - name: Webhook Management
    description: JWT-authenticated webhook endpoint management.
paths:
  /api/developer/workspaces/{workspaceId}/webhooks/{endpointId}/test:
    post:
      tags:
        - Webhook Management
      summary: Send a test.ping delivery to a workspace webhook
      operationId: testWorkspaceWebhook
      parameters:
        - name: workspaceId
          in: path
          required: true
          schema:
            type: string
        - name: endpointId
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Test delivery queued and attempted.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TestWebhookResponse'
        '400':
          description: Invalid request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ManagementErrorResponse'
        '401':
          description: Authentication required.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ManagementErrorResponse'
        '403':
          description: Insufficient entitlement or workspace role.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ManagementErrorResponse'
        '404':
          description: Resource not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ManagementErrorResponse'
        '500':
          description: Internal server error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ManagementErrorResponse'
      security:
        - DashboardJwt: []
components:
  schemas:
    TestWebhookResponse:
      type: object
      required:
        - queued
        - eventId
      properties:
        queued:
          type: boolean
        eventId:
          type: string
    ManagementErrorResponse:
      type: object
      required:
        - statusCode
        - error
        - message
        - requestId
        - timestamp
        - path
      properties:
        statusCode:
          type: integer
          minimum: 400
          maximum: 599
        error:
          type: string
        message:
          oneOf:
            - type: string
            - type: array
              items:
                type: string
        requestId:
          type:
            - string
            - 'null'
        timestamp:
          type: string
          format: date-time
        path:
          type: string
  securitySchemes:
    DashboardJwt:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        Authenticated CollabOS dashboard/session JWT used only for
        `/api/developer/...` management endpoints.

````

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