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

# Send a test event

> Sends one event straight away with a sample payload. Pass `type` to send any event type; the default is `ping`.

Requires the `webhooks:write` scope.



## OpenAPI

````yaml /api-reference/openapi.json post /webhook_endpoints/{endpointId}/test
openapi: 3.1.0
info:
  title: ChargeExpress Fleet API
  version: v1
  description: >-
    Manage your fleet’s drivers, vehicles, limits, charging and wallet, and
    receive webhooks.


    Scopes: `fleet:read` (Read the fleet, drivers, vehicles, sessions, wallet,
    invoices and events); `drivers:write` (Create, update, suspend and remove
    drivers); `vehicles:write` (Create, update and retire vehicles);
    `limits:write` (Change fleet and driver charging limits); `wallet:write`
    (Fund the wallet, pay usage invoices and set the low-balance alert);
    `webhooks:write` (Manage webhook endpoints and redeliver events).
servers:
  - url: https://partners.chargeexpressltd.com/api/public/v1
    description: Production
  - url: https://stage.partners.chargeexpressltd.com/api/public/v1
    description: Stage
security:
  - apiKey: []
paths:
  /webhook_endpoints/{endpointId}/test:
    post:
      tags:
        - Webhooks
      summary: Send a test event
      description: >-
        Sends one event straight away with a sample payload. Pass `type` to send
        any event type; the default is `ping`.


        Requires the `webhooks:write` scope.
      operationId: sendTestEvent
      parameters:
        - schema:
            type: string
          required: true
          name: endpointId
          in: path
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                type:
                  type: string
                  enum:
                    - ping
                    - session.started
                    - session.start_failed
                    - session.completed
                    - session.stopped_by_limit
                    - wallet.funded
                    - wallet.funding_failed
                    - wallet.low_balance
                    - invoice.created
                    - invoice.paid
                    - driver.created
                    - driver.updated
                    - driver.removed
                    - vehicle.created
                    - vehicle.updated
                    - vehicle.retired
                    - invitation.accepted
                    - limit.updated
                    - limit.reached
                  default: ping
              additionalProperties: false
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  object:
                    type: string
                    enum:
                      - webhook_test
                  event_id:
                    type: string
                  type:
                    type: string
                  succeeded:
                    type: boolean
                  response_status:
                    type:
                      - integer
                      - 'null'
                  response_body:
                    type:
                      - string
                      - 'null'
                  error:
                    type:
                      - string
                      - 'null'
                  duration_ms:
                    type: integer
                required:
                  - object
                  - event_id
                  - type
                  - succeeded
                  - response_status
                  - response_body
                  - error
                  - duration_ms
        '400':
          description: Invalid request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Missing or invalid API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: The key lacks the scope this request needs
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '409':
          description: Conflict with the current state
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: Rate limited
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - apiKey: []
components:
  schemas:
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              enum:
                - authentication_error
                - permission_error
                - invalid_request_error
                - rate_limit_error
                - api_error
            code:
              type: string
            message:
              type: string
            param:
              type: string
            request_id:
              type: string
          required:
            - type
            - code
            - message
            - request_id
      required:
        - error
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      description: >-
        Your fleet API key, e.g. `Authorization: Bearer cxk_live_…`. Create keys
        in the fleet portal under Developers.

````

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