Send a test event
POST/api/v1/webhooks/{id}/test
POST /webhooks/{id}/test
curl -X POST 'https://www.unitpost.com/api/v1/webhooks/wh_123/test' \
-H 'Authorization: Bearer YOUR_API_KEY' \
-H 'User-Agent: my-app/1.0'Response · 200
{
"object": "webhook_test",
"delivered": false,
"response_status": 0,
"event_type": "string",
"error": "string"
}Fire a sample event at the endpoint synchronously and return the receiver's response so you can debug your handler end-to-end. The probe is signed exactly like a real delivery (verify it the same way) but is not persisted to the delivery log. Configure the endpoint itself with Update a webhook endpoint. Requires the webhooks:manage capability.
Parameters1 field
| Field | Type | Description |
|---|---|---|
idrequired | string · path | — |
Response · 200 fields5 fields
| Field | Type | Description |
|---|---|---|
objectrequired | enumwebhook_test | — |
deliveredrequired | boolean | Whether the endpoint accepted the probe (2xx). |
response_statusrequired | integer | The HTTP status the endpoint returned, or null on a transport error. |
event_typerequired | string | The sample event type that was sent. |
errorrequired | string | A transport/error message when delivery failed, else null. |
200401403404