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
Headers
Section titled “Headers”
Minor version; defaults to the environment’s pin.OhAuthCat-Versionstring
Request body
Section titled “Request body”kindstring Requiredone of
cert_expiry,connection_error,domain_record_missing,scim_auth_failure
An owner’s or admin’s email of the environment’s account.tostring Requiredmax length 320
Responses
Section titled “Responses”- 202 Sent. TestEmail
- 400 Invalid request. Codes: parameter_invalid, parameter_missing, version_unsupported and resource-specific codes from the catalogue. Error
- 401 Codes: authentication_required, api_key_invalid. Error
- 403 Codes: api_key_scope_missing, ip_not_allowed, plan_limit_reached. Error
- 429 Code: rate_limited. Retry-After is set. Error
- 503 Code: service_unavailable. Retry-After is set; writes are paused. Error
- default Any other error, including internal_error. Every code is in the error catalogue. Error
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"}'const response = await fetch("https://api.ohauthcat.com/v1/email_events/test", { method: "POST", headers: { Authorization: `Bearer ${process.env.OHAUTHCAT_API_KEY}`, "Content-Type": "application/json", }, body: JSON.stringify({ "kind": "cert_expiry", "to": "example_to" }),});const data = await response.json();import osimport requests
response = requests.post( "https://api.ohauthcat.com/v1/email_events/test", headers={"Authorization": f"Bearer {os.environ['OHAUTHCAT_API_KEY']}"}, json={ "kind": "cert_expiry", "to": "example_to", },)data = response.json(){ "object": "test_email", "kind": "default", "status": "sent"}