# Send a test event

Adresse: https://docs.athaus.ai/api/v1/referenz/test-webhook-endpoint

> Aufruf, Parameter, Antwort und Fehler von POST /v1/webhookEndpoints/{id}/test.

Typ: Referenz
Zuletzt aktualisiert: 2026-11-14

Sends one signed event of the type `webhook_endpoint.test` to the endpoint, now, once, and answers with the result. There is no retry, and the status of the endpoint and its last delivery stay as they are. It is sent even if the endpoint is disabled. Needs write access to `webhookEndpoints`.

Braucht den Scope [`propose`](/api/v1/anmeldung#scopes).

## Aufruf [#aufruf]

```http
POST https://api.athaus.ai/v1/webhookEndpoints/{id}/test
```

### Parameter [#parameter]

**Pfad**

| Name | Typ             | Pflicht | Beschreibung                  |
| ---- | --------------- | ------- | ----------------------------- |
| `id` | `string (uuid)` | ja      | UUID of the webhook endpoint. |

**Kopf**

| Name              | Typ      | Pflicht | Beschreibung                                                                                                                                                                                                                                                                                                                                                                                                                         |
| ----------------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `Athaus-Version`  | `string` | nein    | Optional and carries nothing a client needs: the version is the path. Accepted when it says `v1` or `1`. Any other value is a 400 `api_version_unsupported`.                                                                                                                                                                                                                                                                         |
| `Idempotency-Key` | `string` | nein    | Makes a retry safe: the same key with the same body returns the first answer and writes nothing twice. A random value of at least 128 bits, for example a UUID, 1 to 255 characters. The key is kept for 24 hours and scoped to the API key and this operation. The same key with a different body is a 422; while the first request still runs it is a 409. Only successful answers are kept: after an error the key is free again. |

### Beispiel [#beispiel]

```bash
curl -X POST "https://api.athaus.ai/v1/webhookEndpoints/0190f3a2-7c1e-7b0e-9a41-5d2f6e8c3b17/test" \
  -H "Authorization: Bearer ath_live_..." \
  -H "Idempotency-Key: $(uuidgen)"
```

## Antwort [#antwort]

Bei Erfolg kommt `200` mit `WebhookTest`.

### WebhookTest [#webhooktest]

| Feld         | Typ               | Beschreibung                                                                                          |
| ------------ | ----------------- | ----------------------------------------------------------------------------------------------------- |
| `object`     | `string`          | Immer `webhook_test`.                                                                                 |
| `endpointId` | `string`          |                                                                                                       |
| `eventId`    | `string`          | UUID of the test event. Its type is `webhook_endpoint.test`.                                          |
| `delivered`  | `boolean`         | True if the receiver answered with a 2xx status.                                                      |
| `status`     | `integer \| null` |                                                                                                       |
| `error`      | `string \| null`  | `connection_refused`, `timeout`, `tls_error`, `http_4xx`, `http_5xx` or `address`; null if delivered. |

### Köpfe der Antwort [#köpfe-der-antwort]

| Kopf                  | Beschreibung                                                                                                    |
| --------------------- | --------------------------------------------------------------------------------------------------------------- |
| `Request-Id`          | Identifies this request. Quote it in a support request.                                                         |
| `Athaus-Version`      | The API version of this response: v1.                                                                           |
| `Athaus-Release`      | The release of v1 that answered, for example 1.0. A label for support and changelogs; no request can select it. |
| `RateLimit-Policy`    | The quota policy of the bucket that applies.                                                                    |
| `RateLimit`           | Remaining quota and seconds until the bucket is full again.                                                     |
| `Idempotent-Replayed` | `true` when this is the stored answer to an earlier request with the same Idempotency-Key.                      |

## Fehler [#fehler]

Jeder Fehler kommt als [Problem Details](/api/v1/fehler). Verzweige auf `code`, nicht auf `title` oder `detail`.

| Status | Codes                                                                                                            | Bedeutung                                                                                                   |
| ------ | ---------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
| `400`  | [`invalid_id`](/api/errors#invalid_id), [`api_version_unsupported`](/api/errors#api_version_unsupported)         | Invalid request.                                                                                            |
| `401`  | [`unauthorized`](/api/errors#unauthorized)                                                                       | Missing or invalid API key.                                                                                 |
| `403`  | [`insufficient_permissions`](/api/errors#insufficient_permissions), [`plan_required`](/api/errors#plan_required) | The key lacks a right, or the plan does not include API access.                                             |
| `404`  | [`not_found`](/api/errors#not_found)                                                                             | Nothing under this ID.                                                                                      |
| `409`  |                                                                                                                  | The request conflicts with the state of the resource (for example a duplicate), or with an idempotency key. |
| `422`  |                                                                                                                  | The idempotency key was already used with a different request body.                                         |
| `429`  | [`rate_limited`](/api/errors#rate_limited)                                                                       | Rate limit exceeded.                                                                                        |
| `500`  | [`internal_error`](/api/errors#internal_error)                                                                   | Server error.                                                                                               |
