Waiting for an email in a test

Start the wait, then trigger the product to send mail to that address. The call returns the captured message, or fails when nothing arrives in time. Set DEVHELM_WORKSPACE_ID to the workspace that owns the domain. The SDK sends it for you when that variable is set. REST calls send it as x-phelm-workspace-id.

SDK

to is the full address. timeoutMs / timeout_ms is milliseconds (60 seconds below). The maximum is 120000.

const message = await client.email.wait({
  to: "signup@your-domain.example",
  timeoutMs: 60_000,
});
console.log(message.subject);

message = client.email.wait(
    to="signup@your-domain.example",
    timeout_ms=60_000,
)
print(message.subject)

The SDK starts the lookback at the moment you call wait. Mail that arrived earlier is not returned. Pass receivedAfter / received_after when the message may already be stored. When you already split the address, waitLocalPart / wait_local_part posts to /api/v1/email/{localpart}/wait and sends domain in the body.

CLI

devhelm email wait --to signup@your-domain.example --timeout-ms 60000

The table includes an OTP column. JSON output is the message.

REST

curl -X POST "https://api.devhelm.io/api/v1/email/wait" \
  -H "Authorization: Bearer $DEVHELM_API_TOKEN" \
  -H "x-phelm-workspace-id: $DEVHELM_WORKSPACE_ID" \
  -H "Content-Type: application/json" \
  -d '{"to":"signup@your-domain.example","timeoutMs":60000}'

Omit receivedAfter and the API looks back 60 seconds. A wait that finds nothing returns HTTP 408 with code WAIT_TIMEOUT.

Getting Started

Webhook testing

Monitoring as Code

Monitoring

Incidents

Alerting

Status Data

Email testing

Platform

Common Patterns

Waiting for an email in a test

SDK

CLI

REST

Next steps

OTPs and links

How capture works

​SDK

​CLI

​REST

​Next steps

OTPs and links

How capture works

SDK

CLI

REST

Next steps