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

# Send Test Event

> Sends a test webhook event to verify endpoint configuration

## Request Body

<ParamField body="event_type" type="string" default="api.webhook.test">
  Event type to send. Defaults to `api.webhook.test`
</ParamField>

<ParamField body="endpoint_id" type="string">
  Specific endpoint to test. If not provided, tests all active endpoints
</ParamField>

<RequestExample>
  ```json theme={null}
  {
    "event_type": "api.webhook.test",
    "endpoint_id": "ep_2KtRQ8fTStWPKrXP"
  }
  ```
</RequestExample>

<ResponseExample>
  ```json theme={null}
  {
    "message": "Test event sent successfully",
    "message_id": "msg_2KtRQ8fTStWPKrXQ",
    "endpoints_notified": 1
  }
  ```
</ResponseExample>

## Response Fields

<ResponseField name="message" type="string">
  Success message
</ResponseField>

<ResponseField name="message_id" type="string">
  ID of the test message sent
</ResponseField>

<ResponseField name="endpoints_notified" type="integer">
  Number of endpoints that were notified
</ResponseField>

<Note>
  This endpoint is useful for testing webhook configuration during development or debugging webhook delivery issues.
</Note>

## Test Event Payload

The test event sent to your webhook endpoint will have the following structure:

```json theme={null}
{
  "id": "evt_test_123456789",
  "type": "api.webhook.test",
  "created": "2024-01-15T10:00:00Z",
  "data": {
    "message": "This is a test webhook event",
    "endpoint_id": "ep_2KtRQ8fTStWPKrXP"
  }
}
```
