workwae documentation

One REST API for Gmail, Microsoft 365 and IMAP mailboxes and Google and Microsoft calendars: connect accounts, read and send mail, manage events, and get told about changes by webhooks or the change feed.

Guides

QuickstartInstall the SDK, create an API key, make your first calls, connect a mailbox and follow the change feed.Errors, pagination and limitsError bodies and every reason, list envelopes and cursors, rate limits, request ids and idempotency keys.WebhooksReceive events, verify their signatures, and use the delivery log, replays and test events.Connect flowsHosted connect pages, headless OAuth, refresh-token import, your own OAuth apps and reauthorization.IMAP and SMTPPassword accounts, server autodiscovery, IMAP with OAuth, and the hosted IMAP form.Sending mailThe outbox, scheduling and undo, drafts, mail merges, templates, tracking and unsubscribes.TemplatesHandlebars and Markdown templates: variables, escaping, previews and sending with them.Suppression listsNamed lists, unsubscribes and bounces, and reviewing opt-outs found in replies.CalendarCalendars and events, recurring series, invitations, online meetings and finding a free time.ContactsList, search and write contacts across Google, Microsoft 365 and CardDAV, with photos.

API reference

API referenceEvery operation of /v1 (119 operations in 21 groups), with parameters, schemas, errors and curl and SDK examples, rendered from the live OpenAPI document.ChangelogWhat changed in the API and the SDK, newest first, with the breaking changes and how to migrate.

Concepts

A tenant is your organization on the board. It owns API keys, webhook endpoints, settings and accounts: connected mailboxes, each with a provider (gmail, graph for Microsoft 365, or imap) and your own externalRef.

workwae keeps an index of each account's mailboxes, messages and calendar events in sync, inside the account's sync window. Every change becomes an event with a stable id, delivered to your webhook endpoints and kept in the change feed.