Send a test event to an organization webhook
POST/api/v1/organizations/{id}/webhooks/{webhook_id}/test
POST /organizations/{id}/webhooks/{webhook_id}/test
curl -X POST 'https://www.unitpost.com/api/v1/organizations/org_123/webhooks/wh_123/test' \
-H 'Authorization: Bearer YOUR_ORG_KEY' \
-H 'User-Agent: my-app/1.0'Response · 200
{
"object": "webhook_test",
"delivered": false,
"response_status": 0,
"event_type": "string",
"error": "string"
}Send a sample event now, signed like a real delivery, and answer with your endpoint's response. It is not kept in the delivery log. A test happens in no workspace: its workspace_id and external_id are null. Takes an organization key (ok_live_…) with organizations:write.
Parameters2 fields
| Field | Type | Description |
|---|---|---|
idrequired | string · path | The organization's id (`org_…`), from `GET /whoami` or Organization → API. |
webhook_idrequired | string · path | The organization webhook endpoint's id (`wh_…`). |
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. |
200401403404429