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

# Send a test event to a webhook endpoint

> Queues a signed `ping` event to the endpoint, whatever its event types, and returns the pending delivery. Poll the endpoint's deliveries for the outcome.



## OpenAPI

````yaml /openapi/platform-v1.yaml post /api/v1/webhook-endpoints/{id}/test
openapi: 3.0.1
info:
  title: CrewAI Platform API
  version: v1
  description: Supported public API for CrewAI Platform.
servers:
  - url: https://app.crewai.com
    description: Current CrewAI Platform host
security:
  - bearerAuth: []
tags:
  - name: Users
    description: Users in the organization.
  - name: Status
    description: Platform health and API availability.
  - name: Automations
    description: Automations and their source artifacts.
  - name: Teams
    description: Teams in the organization.
  - name: Group Mappings
    description: Identity-provider group mappings to Teams.
  - name: Service Accounts
    description: Service accounts in the organization.
  - name: Webhook Endpoints
    description: Endpoints that receive signed event deliveries.
paths:
  /api/v1/webhook-endpoints/{id}/test:
    parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          example: 4f6d0d9a-7b78-4c6a-b64f-2e2e3d2c8f9a
    post:
      tags:
        - Webhook Endpoints
      summary: Send a test event to a webhook endpoint
      description: >-
        Queues a signed `ping` event to the endpoint, whatever its event types,
        and returns the pending delivery. Poll the endpoint's deliveries for the
        outcome.
      operationId: testWebhookEndpoint
      responses:
        '202':
          description: Accepted
          content:
            application/json:
              examples:
                queued:
                  value:
                    data:
                      id: 4f6d0d9a-7b78-4c6a-b64f-2e2e3d2c8f9a
                      event:
                        id: 8f14e45f-ceea-467a-9f8e-1c2d3e4f5a6b
                        type: ping
                      status: pending
                      attempts: 0
                      response_status: null
                      response_body: null
                      last_attempted_at: null
                      delivered_at: null
                      created_at: '2026-07-07T00:00:00Z'
                      updated_at: '2026-07-07T00:00:00Z'
                  summary: Test event queued
              schema:
                type: object
                required:
                  - data
                additionalProperties: false
                properties:
                  data:
                    type: object
                    required:
                      - id
                      - event
                      - status
                      - attempts
                      - response_status
                      - response_body
                      - last_attempted_at
                      - delivered_at
                      - created_at
                      - updated_at
                    additionalProperties: false
                    properties:
                      id:
                        type: string
                        format: uuid
                        example: 4f6d0d9a-7b78-4c6a-b64f-2e2e3d2c8f9a
                      event:
                        type: object
                        required:
                          - id
                          - type
                        additionalProperties: false
                        properties:
                          id:
                            type: string
                            format: uuid
                            example: 4f6d0d9a-7b78-4c6a-b64f-2e2e3d2c8f9a
                            description: The event's `id`, also sent in the delivery body.
                          type:
                            type: string
                            example: automation_deployed
                      status:
                        type: string
                        enum:
                          - pending
                          - delivering
                          - delivered
                          - failed
                        example: delivered
                        description: >
                          Where the delivery stands:

                          - `pending`: Waiting for its first attempt or a retry.

                          - `delivering`: An attempt is in progress.

                          - `delivered`: The endpoint answered with a 2xx
                          status.

                          - `failed`: CrewAI stopped trying.
                      attempts:
                        type: integer
                        example: 1
                      response_status:
                        type: integer
                        nullable: true
                        example: 200
                      response_body:
                        type: string
                        example: ok
                        nullable: true
                        description: The first 2 KB of the endpoint's last response.
                      last_attempted_at:
                        type: string
                        format: date-time
                        example: '2026-07-07T00:00:00Z'
                        nullable: true
                      delivered_at:
                        type: string
                        format: date-time
                        example: '2026-07-07T00:00:00Z'
                        nullable: true
                      created_at:
                        type: string
                        format: date-time
                        example: '2026-07-07T00:00:00Z'
                      updated_at:
                        type: string
                        format: date-time
                        example: '2026-07-07T00:00:00Z'
        '401':
          description: Unauthorized
          content:
            application/json:
              examples:
                unauthorized:
                  value:
                    errors:
                      - type: >-
                          https://docs-platform.crewai.com/api/problems/unauthorized
                        code: unauthorized
                        title: Unauthorized
                        status: 401
                        detail: Missing or invalid bearer token.
                  summary: Missing or invalid bearer token
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '404':
          description: Not Found
          content:
            application/json:
              examples:
                not_found:
                  value:
                    errors:
                      - type: >-
                          https://docs-platform.crewai.com/api/problems/not_found
                        code: not_found
                        title: Not found
                        status: 404
                        detail: The requested resource could not be found.
                  summary: >-
                    Webhook endpoint is outside the authenticated service
                    account's organization
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
components:
  schemas:
    ErrorEnvelope:
      type: object
      required:
        - errors
      additionalProperties: false
      properties:
        errors:
          type: array
          minItems: 1
          items:
            $ref: '#/components/schemas/Error'
    Error:
      type: object
      description: Public API error object.
      required:
        - type
        - code
        - title
        - status
        - detail
      additionalProperties: false
      properties:
        type:
          type: string
          format: uri
          enum:
            - https://docs-platform.crewai.com/api/problems/bad_request
            - https://docs-platform.crewai.com/api/problems/clipper_disabled
            - https://docs-platform.crewai.com/api/problems/clipper_disallowed
            - >-
              https://docs-platform.crewai.com/api/problems/clipper_feature_disabled
            - https://docs-platform.crewai.com/api/problems/clipper_not_found
            - https://docs-platform.crewai.com/api/problems/conflict
            - https://docs-platform.crewai.com/api/problems/forbidden
            - https://docs-platform.crewai.com/api/problems/internal_error
            - https://docs-platform.crewai.com/api/problems/not_found
            - https://docs-platform.crewai.com/api/problems/service_unavailable
            - >-
              https://docs-platform.crewai.com/api/problems/tool_execution_failed
            - https://docs-platform.crewai.com/api/problems/unauthorized
            - https://docs-platform.crewai.com/api/problems/validation_error
          example: https://docs-platform.crewai.com/api/problems/bad_request
        code:
          type: string
          enum:
            - bad_request
            - clipper_disabled
            - clipper_disallowed
            - clipper_feature_disabled
            - clipper_not_found
            - conflict
            - forbidden
            - internal_error
            - not_found
            - service_unavailable
            - tool_execution_failed
            - unauthorized
            - validation_error
          example: bad_request
        title:
          type: string
          x-crewai-enum-format: freeform
          enum:
            - Bad request
            - Clipper resource disabled
            - Clipper resource disallowed
            - Clipper feature disabled
            - Clipper resource not found
            - Conflict
            - Forbidden
            - Internal error
            - Not found
            - Service unavailable
            - Tool execution failed
            - Unauthorized
            - Validation error
          example: Bad request
        status:
          type: integer
          enum:
            - 400
            - 401
            - 403
            - 404
            - 409
            - 422
            - 500
            - 503
          example: 400
        detail:
          type: string
          example: The request is invalid.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: opaque

````