Search documentation

Search for a topic, a control, or an event type.

    Docs / Workflows / Integrations / Omnivery

    Omnivery

    Send email through a configured Omnivery domain, read its stats and receive delivery, open and click events.

    What you can do

    Each Omnivery integration’s page in OAIZ shows these uses, with its events and its read and write actions, under What you can do with Omnivery.

    Welcome emails
    Send a welcome email when someone signs up.
    Click follow-ups
    Follow up with people who clicked a link in your email.
    Delivery reports
    Report delivery and bounce rates every week.

    Connection scope

    The connection has a sending domain, approved sender addresses and a default sender. senderEmail must match an approved address or remain empty to use the default. Credentials apply to this configured sending service.

    Connecting

    The connection asks for Omnivery target JSON and Omnivery credentials JSON. The target names an existing sending domain, approved sender addresses and a default sender. Supply the account management API key as managementApiKey. OAIZ creates a separate domain sending key for this connection.

    Omnivery target JSON
    {
      "domain": "mail.example.com",
      "approvedSenders": [
        {
          "email": "hello@example.com",
          "name": "Example"
        }
      ],
      "defaultSenderEmail": "hello@example.com"
    }
    Omnivery credentials JSON
    {
      "managementApiKey": "YOUR_MANAGEMENT_API_KEY"
    }

    The management key must be able to manage sending keys for the domain. OAIZ also uses it to read the domain’s stats and, when delivery events are enabled, to manage the domain’s webhooks. Supplying the account’s webhook signing key as signingKey enables delivery events.

    Read actions

    Get Domain Stats
    Read accepted, delivered, failed, opened, clicked, unsubscribed and complained counts for the whole sending domain per hour, day, week or month, between two dates in UTC. The counts include email sent from the domain outside OAIZ and cannot be split by tag.

    Write actions

    Send Email
    Send a message through the configured domain using an approved sender, optionally with up to three tags naming the kind of email. The result confirms that Omnivery accepted it for delivery.

    Tags and reporting

    A tag names the kind of email, such as order-confirmation. Tags use letters, digits and the characters "-" and "_", and an email can carry up to three. Omnivery repeats an email’s tags on every delivery, bounce, open and click event for it, so delivery, open and click rates can be grouped by kind of email. Email sent from the domain by other systems carries the tags those systems set with o:tag or the X-OV-Tag header.

    Events

    When delivery events are enabled, the connection reports delivery to the recipient’s mail server, temporary and permanent bounces, spam complaints and unsubscribes for every email sent from the domain. Delivery to the server does not prove the person read the email.

    Open and click events report each time an email is opened or a link in it is clicked, with the email’s tags, the clicked link without its query string and the reader’s mail client. Omnivery sends them only while open and click tracking is on for the domain. Mail privacy proxies and security scanners also open email and follow links, and Omnivery flags the ones it detects as suspected bots. OAIZ does not keep the reader’s IP address or location.

    The Event subscriptions setting on the connection selects which of the seven event types OAIZ receives: Delivered, Temporary delivery failure, Permanent delivery failure, Spam complaint, Unsubscribed, Opened and Clicked. A connection with delivery events enabled starts with all seven selected. The selection can change at any time without reconnecting, and it can be empty. OAIZ does not receive events of a type while it is turned off, and turning it on again does not recover them. A connection made without the signing key has no event subscriptions until it is reconnected with one.