Send a test event to an Endpoint to verify its receiver URL and signature handling.
Webhook is currently in Beta. APIs, fields, and behavior may change in future versions.
POST /api/v1/forward/webhook/endpoints/{endpoint_id}/test
The test event type is webhook.test and does not need to be included in the Endpoint subscription list. Delivery is asynchronous. A successful API response means the test event was accepted, not that the receiver has finished processing it.
Ensure the Endpoint is enabled before calling this API. If it is disabled, the API may still return 202, but delivery_rows is 0 and no callback is sent.
Headers
| Header | Required | Description |
|---|---|---|
Authorization | Yes | Bearer <PAT or administrator SAT> |
Path parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
endpoint_id | string | Yes | Webhook Endpoint ID. |
Example request
Example response
HTTP 202 Accepted
Response fields
| Field | Type | Description |
|---|---|---|
event_id | integer | Identifier for this test request. |
delivery_rows | integer | Number of delivery tasks accepted for this test. |
Errors
| HTTP | Type | Trigger |
|---|---|---|
401 | authentication_error | Authentication is missing, invalid, or expired. |
403 | permission_error | The current token cannot manage Webhooks. |
404 | not_found_error | The Endpoint does not exist or is not visible to the current account. |
500/502/503 | api_error | The test event cannot be sent temporarily. |

