NOnovu
Domains

Test an inbound route

Changed on

Sends a synthetic inbound email through the same delivery path as production (outbound webhooks for webhook routes, signed HTTP to the agent for agent routes). Use dryRun: true to preview the payload without delivering.

post/v1/domains/{domain}/routes/{address}/test

Request

  • Base URL
    https://api.novu.co
  • Auth
    API key in header Authorization

Path parameters

domainstring required
addressstring required

Headers

idempotency-keystring

A header for idempotency purposes

Request body

subjectstring required
textstring
htmlstring
dryRunboolean

When true, returns the payload that would be delivered without invoking outbound webhooks or the agent HTTP endpoint.

Response

OK

matchedboolean required
dryRunboolean required
domainStatus'pending' | 'verified'
mxRecordConfiguredboolean
type'agent' | 'webhook'
wouldDeliverTostring

Human-readable delivery target summary in dry-run mode.

payloadobject

The outbound payload (dry-run only).

Changes