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

# Test webhook handler

> **Required scope:** write

**Required scope:** `write`

### Path parameters

<ParamField path="id" type="string" required>
  Webhook endpoint id
</ParamField>

### Response

`TestResponse`

<ResponseField name="endpoint_id" type="string" required />

<ResponseField name="note" type="string" required />

<ResponseField name="status" type="string" required />

### Status codes

| Code  | Meaning                                            |
| ----- | -------------------------------------------------- |
| `202` | Test event dispatched (fire-and-forget)            |
| `401` | Unauthorized — missing or invalid credentials      |
| `403` | Forbidden — the key/token lacks the required scope |
| `404` | Not found                                          |
| `429` | Rate limited — see Retry-After / X-RateLimit-Reset |

<RequestExample>
  ```bash cURL theme={null}
  curl --request POST \
    --url 'https://api.nsr.stateset.com/api/v1/webhooks/{id}/test' \
    --header 'X-API-Key: YOUR_API_KEY'
  ```
</RequestExample>

<ResponseExample>
  ```json 202 theme={null}
  {
    "endpoint_id": "string",
    "note": "string",
    "status": "string"
  }
  ```
</ResponseExample>