Skip to content
Dashboard
Theme
Theme

Send a test notice email

POST /v1/email_events/test: Send a test notice email.

View Markdown

POST /v1/email_events/test

Mails a sample of one customer-facing notice, with sample data and “[Test]” in the subject, to an owner or admin of the environment’s account, through OhAuthCat’s mail with the environment’s support email as reply-to. At most 5 test emails per environment per hour; more answer rate_limited. The send shows in GET /v1/email_events as kind test_<kind>.

Scope
environment:write
Auth
Secret key (sk_…)
Since
1.0
  • OhAuthCat-Version string

    Minor version; defaults to the environment’s pin.

  • kind string Required

    one of cert_expiry, connection_error, domain_record_missing, scim_auth_failure

  • to string Required

    An owner’s or admin’s email of the environment’s account.

    max length 320

Errors share one shape; see the error code catalogue.

curl -X POST \
"https://api.ohauthcat.com/v1/email_events/test" \
-H "Authorization: Bearer $OHAUTHCAT_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"kind": "cert_expiry",
"to": "example_to"
}'
Response 202
{
"object": "test_email",
"kind": "default",
"status": "sent"
}