Emails

Simulate a webhook event (test sink for CI)

Builds the payload for an outbound email event and, by default, delivers it to your webhook endpoints. email.received is inbound-only and cannot be simulated here.

post/emails/test

Request

  • Base URL: https://api.supersendtx.com
  • URL: https://api.supersendtx.com/emails/test
  • Auth: HTTP bearer

Request body

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

Outbound email events that POST /emails/test can simulate. email.received is inbound-only, so it is not accepted there.

email_idstring

Optional existing email public id (msg_…). Without it, the payload describes a sample email.

webhook_idstring uuid

Optional webhook endpoint id (the id returned by POST /webhooks) 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, deliver the payload to your webhook endpoints subscribed to the event (in the background unless sync is true)

Response

Payload built (and optionally delivered)

okboolean required
deliveredboolean required

Changes

No recorded changes to this operation across all 1 revision of this API.