Runs examples for real against your account. Test keys only; kept in this tab, never stored on our side. Get a key
ZapSMTP / Docs / Webhooks

Send a test event

POST/v1/webhooks/{id}/test

Send a signed sample event to the endpoint now and report the result.

Requires a full-access live key; test keys get 403 test_key_restricted.

Test events are not retried. delivery.error is present when the attempt failed (e.g. "HTTP 500"); status_code is 0 on network errors. The test attempt is recorded in the delivery log.

Path parameters

idstringrequired
Webhook id

Body parameters

typestring
Limits: 422 invalid_parameter "unknown event type" One of email.sent, email.delivered, email.delivery_delayed, email.bounced, email.complained, email.failed, email.opened, email.clicked, email.suppressed, email.received, thread.created, thread.replied, email.replied. Default email.delivered.

Errors

restricted_api_keyHTTP 403
test_key_restrictedHTTP 403
test-mode keys can send test email and read, not change the account: use a live key
not_foundHTTP 404
webhook not found
invalid_parameterHTTP 422
POST/v1/webhooks/{id}/test
curl -X POST 'https://zapsmtp.xyz/v1/webhooks/019a1c55-0d6e-7f21-8b3a-5e9d4c7b2a10/test' \
  -H "Authorization: Bearer $ZAP_API_KEY" \
  -H 'Content-Type: application/json' \
  -d '{
  "type": "email.delivered"
}'
Set ZAP_API_KEY in your environment.
Response 200 OK
{
  "ok": true,
  "delivery": {
    "event_id": "evt_test_9Gk2Lq7Xv1Rb4Tz8",
    "event_type": "email.delivered",
    "attempt": 1,
    "status_code": 200,
    "duration_ms": 143,
    "at": "2026-10-21T15:50:00.123Z",
    "body": {
      "id": "evt_test_9Gk2Lq7Xv1Rb4Tz8",
      "type": "email.delivered",
      "created_at": "2026-10-21T15:50:00.120Z",
      "data": {
        "email_id": "00000000-0000-0000-0000-000000000000",
        "from": "Test <test@example.com>",
        "to": "recipient@example.com",
        "subject": "ZapSMTP webhook test",
        "response": {
          "code": 250,
          "message": "OK (test event)"
        }
      }
    }
  },
  "payload": {
    "id": "evt_test_9Gk2Lq7Xv1Rb4Tz8",
    "type": "email.delivered",
    "created_at": "2026-10-21T15:50:00.120Z",
    "data": {
      "email_id": "00000000-0000-0000-0000-000000000000",
      "from": "Test <test@example.com>",
      "to": "recipient@example.com",
      "subject": "ZapSMTP webhook test",
      "response": {
        "code": 250,
        "message": "OK (test event)"
      }
    }
  }
}