canonical: https://jentic.com/apis/omnivery.com/omnivery

# Omnivery Automations API

The Omnivery Automations API delivers transactional email, validates recipient addresses, detects bots interacting with messages, and manages sender domains. It exposes endpoints for sending messages, suppressing addresses, parsing email syntax, retrieving honeypot links, and subscribing to webhook events for delivery activity. Domain management endpoints let teams list configured sending domains and inspect their status, while bot detection scores interactions to filter automated traffic from engagement metrics.

## For AI agents

Send transactional emails, validate addresses, detect bots, and manage sender domains and webhooks for the Omnivery email platform.

## Scope

Does not handle SMS, push notifications, or marketing campaign design - use for transactional email send, validation, and bot detection only.

## Capabilities

- Send transactional email messages through configured Omnivery sending domains
- Validate recipient email addresses before adding them to a send list
- Suppress specific addresses to prevent future deliveries to known bouncers
- Detect and score bot interactions against email links and pixels
- Subscribe webhooks to delivery, open, click, and bounce event types
- Inspect honeypot link interactions to flag suspicious recipient behaviour
- Manage sending domains and inspect their configuration status

## Use cases

### Transactional Email Delivery

Deliver password resets, receipts, and account notifications through Omnivery's sending infrastructure. The POST /{domain}/messages endpoint accepts the recipient, subject, and body and queues the message against a verified sending domain. Suppression and validation endpoints help keep the sender reputation clean before each send.

Example prompt: Send a transactional email from no-reply@example.com to a verified recipient with subject 'Password reset' and a one-time link in the body.

### Bot Filtering on Engagement Metrics

Distinguish real recipients from automated scanners by submitting interaction events to the bot detection endpoint and reading back a request-level verdict. The POST /{domain}/bot endpoint validates an interaction, and GET /{domain}/bot/{request_id} retrieves the stored result for downstream analytics or filtering.

Example prompt: Submit a click event to /{domain}/bot for request_id abc123 and retrieve the bot verdict before counting the click in engagement reports.

### Address Validation and Suppression Hygiene

Keep mailing lists clean by validating each address before adding it and suppressing addresses that have hard-bounced. GET /{domain}/validate scores an address for deliverability, and POST /{domain}/suppress adds an address to the per-domain suppression list so future sends skip it automatically.

Example prompt: Validate user@example.com via GET /{domain}/validate; if the response marks it undeliverable, post it to /{domain}/suppress.

### Agent-Driven Email Workflows via Jentic

AI agents trigger Omnivery email sends, validate addresses, and react to webhook events through Jentic's intent search without storing the API key in the agent context. The agent searches for the send operation, loads its schema, and executes it with parameters supplied by upstream tools.

Example prompt: Use Jentic search 'send transactional email omnivery' to locate POST /{domain}/messages, load the schema, and execute the send.

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/{domain}/messages` | Send an email message |
| GET | `/{domain}/validate` | Validate a recipient address |
| POST | `/{domain}/suppress` | Suppress an address from future sends |
| POST | `/{domain}/bot` | Submit an interaction for bot detection |
| GET | `/{domain}/bot/{request_id}` | Retrieve a stored bot detection result |
| POST | `/domains/{domain}/webhooks` | Subscribe a webhook to delivery events |
| GET | `/domains` | List configured sending domains |

## Key resources

- **Messages** — Send email messages through verified sending domains
- **Webhooks** — Subscribe to delivery, click, bounce, and open events with sample payload retrieval
- **Bot Detection** — Submit interactions for scoring and retrieve verdicts by request id
- **Domains** — List and inspect configured sending domains
- **Validation** — Validate addresses and parse email syntax before sending

## Why Jentic

- **Setup:** Wiring the Omnivery Automations API by hand means passing its API key in the ov-token header and building each transactional send, validation, and bot-detection call against zap-api.omnivery.net yourself. Through Jentic you install once, import the Omnivery Automations API from the API Directory, store the key once, and your agent calls it.
- **Permission scoping:** Omnivery puts the sending domain in the URL path (/{domain}/messages, `/domains/{domain}/webhooks`), so a rule can pin your agent to one domain: it can send and validate for that domain and nothing else. You choose the operations it may call, so suppression writes or webhook registration are not included unless you add them.
- **Credential handling:** Your Omnivery API key is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'send a transactional email through omnivery' or 'validate an address', and Jentic returns the matching Omnivery operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Mailgun API** — Mailgun is a larger transactional email platform with similar send, validate, and webhook primitives.
- **SendGrid Email Activity** — SendGrid offers comparable transactional email delivery with extensive activity and analytics endpoints.
- **Postmark Server API** — Postmark focuses on fast transactional delivery and can be used alongside Omnivery for failover.

## FAQ

### What authentication does the Omnivery Automations API use?

The API uses an API key passed as a request header. Through Jentic the key is held in the encrypted vault (your Jentic One instance) and never enters the agent context - agents receive a scoped reference only.

### Can I send transactional email with the Omnivery Automations API?

Yes. POST /{domain}/messages queues a message against a verified sending domain. Combine with GET /{domain}/validate before adding new recipients to keep bounce rates low.

### How does bot detection work in the Omnivery API?

Submit an interaction to POST /{domain}/bot to receive a request id, then call GET /{domain}/bot/{request_id} to read back the verdict. Honeypot link clicks can also be inspected via GET /{domain}/{message_id}/hclick.

### What are the rate limits for the Omnivery Automations API?

Rate limits are not declared in the OpenAPI spec; consult docs.omnivery.com for current account-tier limits and burst allowances.

### How do I subscribe to delivery webhooks through Jentic?

Search Jentic for 'subscribe omnivery webhook', load the POST `/domains/{domain}/webhooks` schema, then execute with the target URL and webhook type. Sample payloads are available via GET `/domains/{domain}/webhooks/{webhooktype}/sample.`

### Is the Omnivery API free?

Omnivery offers paid sending tiers; pricing depends on volume and feature mix. Check docs.omnivery.com for current plans before committing production traffic.

### Can I limit what my agent is allowed to do with the Omnivery Automations API?

Yes. Because Omnivery puts the sending domain in the URL path, such as /{domain}/messages and `/domains/{domain}/webhooks`, a rule in your self-hosted Jentic One instance can pin your agent to a single domain so it can only send and validate for that domain and nothing else. You decide which operations it may call, so higher-risk actions like POST /{domain}/suppress or webhook registration stay off limits unless you add them. Your Omnivery API key is stored by your own instance and injected only at execution, never entering the agent's context.