Skip to main content
OpenIndex routes inbound email to work item conversations through mailboxes and routing rules. Email infrastructure (receiving domains and webhooks) is provisioned through Resend. All admin email endpoints require an admin-scoped token. See Email Infrastructure for the setup walkthrough.

​
Mailboxes

Mailboxes define the default routing behavior for inbound email arriving at a provisioned receiving domain.

​
List mailboxes

​
Create a mailbox

​
string
required
Display name for the mailbox.
​
string
required
The inbound email address this mailbox handles (e.g. support@support.example.com).
​
string
required
Default domain to route matched emails to as work item conversations.

​
Update a mailbox

​
Delete a mailbox

Deleting a mailbox removes all routing rules associated with it. Emails arriving at the mailbox address will no longer be routed to work items.

​
Routing rules

Routing rules override a mailbox’s default domain routing based on inbound email match criteria. Rules are evaluated in order; the first match wins.

​
List routing rules

​
Create a routing rule

​
string
required
The email field to match against: from, to, subject, or body.
​
string
required
The value or pattern to match.
​
string
required
Domain to route matching emails to.
​
number
Rule evaluation order. Lower numbers are evaluated first.

​
Update a routing rule

​
Delete a routing rule

​
Email provider

Returns the Resend account and provider state for your deployment. Use this to verify your Resend API key is configured correctly before provisioning domains or webhooks.

​
Email domains

Receiving domains are provisioned in Resend and configured with DNS records to accept inbound email.

​
List email domains

​
Provision a domain

Returns the domain ID and DNS records to configure at your DNS provider.

​
Refresh domain state

Pulls the latest state for this domain from Resend, including current DNS verification status.

​
Verify a domain

Triggers a DNS verification check in Resend. Run this after adding the required DNS records.

​
Delete a domain

​
Webhooks

Inbound email webhooks forward received messages from Resend to your OpenIndex deployment.

​
List webhooks

​
Provision a webhook

Registers the inbound email webhook endpoint with Resend. OpenIndex receives inbound emails at POST /webhooks/resend/email-received.

​
Refresh webhook state

​
Inbound email webhook

This endpoint is called by Resend when an inbound email arrives at your provisioned receiving domain. OpenIndex verifies the payload signature using RESEND_WEBHOOK_SECRET and routes the email to the matching work item conversation.
You do not call this endpoint directly. Configure your Resend account to forward inbound email to this URL by using POST /admin/external/email/webhooks/provision.