Emails

Simulate a webhook event (test sink for CI)

Changed on
post/emails/test

Request

  • Base URL: https://api.groundmail.dev
  • URL: https://api.groundmail.dev/emails/test
  • Auth: HTTP bearer

Request body

event'email.received' | 'email.sent' | 'email.delivered' | 'email.delivery_delayed' | 'email.held' | 'email.bounced' | 'email.complained' | 'email.opened' | 'email.clicked' | 'email.failed' | 'email.suppressed' | 'email.scheduled' required
email_idstring

Optional existing email public id (msg_…)

webhook_idstring

Optional webhook endpoint id (wh_…) for a single-endpoint test delivery

syncboolean

When true, deliver synchronously and return per-endpoint HTTP results (defaults to true when webhook_id is set)

deliverboolean

When true, enqueue deliveries to account webhooks

tenantstring

Put this tenant (external_id or id) on the payload, so endpoints filtered to that tenant receive it. Testing a tenant-filtered endpoint with webhook_id needs one of its tenants.

Response

Payload built (and optionally delivered)

okboolean required
deliveredboolean required

Changes