Send a test event to a webhook endpoint
Deprecated. Use POST /v1/accounts/{account_id}/webhooks/{webhook_id}/test, which behaves identically.
Sends a synthetic payload to the subscription's URL immediately, outside the normal delivery queue. Use it to verify that your endpoint is reachable and handles deliveries correctly before you rely on real events.
- Payload: carries "test": true and synthetic data, and is signed like any other delivery, so it also exercises your signature check.
- Retries: none. A failed test is not retried and does not appear in the delivery history.
- Idempotency-Key: repeating the call with the same key returns the cached result without sending the test payload again.
- Result: read delivery_success; a delivery your endpoint rejected is still a successful test run, not an error.
Retires on 9 December 2026. See the migration guide for what moved where and what changes when you switch.
Request
- Base URL: https://app.beel.es/api
- URL: https://app.beel.es/api/v1/webhooks/{webhook_id}/test
- Auth: HTTP bearer
Path parameters
Headers
Idempotency key to prevent duplicates in sensitive operations.
- Any unique client-generated string (e.g. an order id). A UUID also works but is not required
- Allowed characters: letters, digits, _ and - (max 255 chars)
- Retrying with the same key replays the first response when it was a success (2xx) or a server error (5xx): same status and body, plus the header Idempotency-Replay: true. After a 5xx, check whether the operation took effect before retrying with a new key
- A 4xx is not stored: the key is released, so the corrected request can reuse it
- Stored responses expire 24 hours after processing
The key is scoped per user and environment, and bound to the request body, so retrying after a network timeout replays the stored response instead of repeating the operation.
| Status | Code | When |
|---|---|---|
| 400 | INVALID_IDEMPOTENCY_KEY | The key breaks the format rules above. |
| 409 | IDEMPOTENCY_KEY_PROCESSING | The first request is still in flight. Wait for the Retry-After seconds (2) and retry with the same key. |
| 409 | IDEMPOTENCY_KEY_MISMATCH | The key was already used with a different body. Use a new key. |
Response
The test was attempted. Check delivery_success for the outcome: a delivery your endpoint rejected is still a successful test run, not an error.
Example response
{
"success": true,
"meta": {
"timestamp": "2025-01-15T10:30:00Z",
"request_id": "4bf92f3577b34da6a3ce929d0e0e4736"
}
}Changes
No recorded changes to this operation across all 1 revision of this API.