Skip to content
AI Inbx
Esc
navigateopen⌘Jpreview
On this page

mailbox.connected

A customer finished authorizing a Gmail or Outlook mailbox.

A customer finished authorizing a Gmail or Outlook mailbox.

Payload

PropType
mailbox_idstring

mbx_…

Typestring
addressstring

The mailbox address.

Typestring
provider"google" | "microsoft"

Which provider.

Type"google" | "microsoft"
app_idstring | null

Your OAuth app, or null when the shared AI Inbx app was used.

Typestring | null
ref?string

The ref you put on the connect link or passed to mailboxes.connect — how you match this to your user.

Typestring
reconnectedboolean

true when this replaced an existing authorization rather than adding a new mailbox.

Typeboolean

Handling it

This — not the browser landing back on return_to — is the signal that the mailbox is live. The redirect happens whether or not the grant completed, and a customer who closes the tab never triggers it at all.

Match on ref — whatever you put on the connect link or passed to mailboxes.connect — to attach the mailbox to the right user in your database.

Mailboxes

The connect flow end to end, including your own OAuth app.

Last updated on September 9, 2026

Was this page helpful?